Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kjaymiller authored Feb 2, 2024
1 parent cfb7200 commit a1f51dc
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,18 @@ These are the options that can be pulled from the page:
| --- | --- |
| `markdown_extras` | A list of extensions to use. See [python-markdown2](https://pypi.org/project/markdown2/) for a list of extensions. |

Check failure on line 15 in README.md

View workflow job for this annotation

GitHub Actions / build

Line length

README.md:15:81 MD013/line-length Line length [Expected: 80; Actual: 138] https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md

## Content Path Type
## Quickstart

Provide a suggestion for the type of content that your parser expects.
import the MarkdownPageParser

\<CONTENTPARSER> expects a `path|url` in the content_path field of the Page object.
Render Engine includes the parser in `render_engine.parsers.markdown`
Alternatively, you can import directly from this path

```python
class MyPage(Page):
content_path = "~/.my_page.md"
# or content_path = "https://example.com/my_page.md"
```py
from render_engine.parsers.markdown import MarkdownPageParser
# of from render_engine_markdown import MarkdownPageParser

class MyMarkdownPage(Page):
Parser = MarkdownPageParser
content_path = "path_to_your_markdown_file.md"
```

0 comments on commit a1f51dc

Please sign in to comment.