File tree Expand file tree Collapse file tree 1 file changed +11
-7
lines changed Expand file tree Collapse file tree 1 file changed +11
-7
lines changed Original file line number Diff line number Diff line change @@ -14,14 +14,18 @@ These are the options that can be pulled from the page:
14
14
| --- | --- |
15
15
| ` markdown_extras ` | A list of extensions to use. See [ python-markdown2] ( https://pypi.org/project/markdown2/ ) for a list of extensions. |
16
16
17
- ## Content Path Type
17
+ ## Quickstart
18
18
19
- Provide a suggestion for the type of content that your parser expects.
19
+ import the MarkdownPageParser
20
20
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
22
23
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"
27
31
```
You can’t perform that action at this time.
0 commit comments