-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cfb7200
commit a1f51dc
Showing
1 changed file
with
11 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: | |
| --- | --- | | ||
| `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 GitHub Actions / buildLine length
|
||
|
||
## 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" | ||
``` |