Skip to content

Commit a1f51dc

Browse files
authored
Update README.md
1 parent cfb7200 commit a1f51dc

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,18 @@ These are the options that can be pulled from the page:
1414
| --- | --- |
1515
| `markdown_extras` | A list of extensions to use. See [python-markdown2](https://pypi.org/project/markdown2/) for a list of extensions. |
1616

17-
## Content Path Type
17+
## Quickstart
1818

19-
Provide a suggestion for the type of content that your parser expects.
19+
import the MarkdownPageParser
2020

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

23-
```python
24-
class MyPage(Page):
25-
content_path = "~/.my_page.md"
26-
# or content_path = "https://example.com/my_page.md"
24+
```py
25+
from render_engine.parsers.markdown import MarkdownPageParser
26+
# of from render_engine_markdown import MarkdownPageParser
27+
28+
class MyMarkdownPage(Page):
29+
Parser = MarkdownPageParser
30+
content_path = "path_to_your_markdown_file.md"
2731
```

0 commit comments

Comments
 (0)