Merge pull request #596 from render-engine/fix-docs

fix the space
render-engine · Feb 18, 2024 · f93f1b1 · f93f1b1
2 parents 8e0a6ba + 020f68a
commit f93f1b1
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 10 deletions.
diff --git a/docs/docs/archive.md b/docs/docs/archive.md
@@ -16,13 +16,12 @@ that focuses on presenting the Collection's pages.
 | --- | --- | --- | --- |
 | `pages` | `list[`[`BasePage`](../page?id=basepage)`]` |The list of pages to include in the archive | _required_ |
 | `title` | `str` |The title of the archive | _required_ |
-| `template` | `str \| Template` |The template to use for the archive | _required_ |
-| `routes` | `list[str \|Path]` |The routes for where the archive page should be generated | _required_ |
+| `template` | `str | Template` |The template to use for the archive | _required_ |
+| `routes` | `list[str |Path]` |The routes for where the archive page should be generated | _required_ |
 | `archive_index` | `int` |The index of the page in the series of archive pages | `0` |
 | `num_of_pages` |  |The total number of pages in the series of archive pages | _required_ |
 
 > !!! Warning Not Directly Used
-
     The Archive object is not meant to be used directly.
     It is used by the [Collection](../collection?id=collection) object.
     Attributes can be used to customize.

diff --git a/docs/docs/cli.md b/docs/docs/cli.md
@@ -79,7 +79,6 @@ You can also use the `--reload` flag to have the site rebuild when changes are m
 Create an HTTP server to serve the site at `localhost`.
 
 > !!! Warning
-
     This is only for development purposes and should not be used in production.
 
 | Name | Type | Description | Default |
@@ -91,5 +90,4 @@ Create an HTTP server to serve the site at `localhost`.
 | `port` | `Annotated[int, Option(--port, -p, help='Port to serve on', show_default=False)]` |Port to serve on | `8000` |
 
 > !!! Note
-
     `--reload` triggers a rebuild after re-importing the site object. Certain changes will not be picked up in the rebuild and reload.
diff --git a/docs/docs/feeds.md b/docs/docs/feeds.md
@@ -11,13 +11,11 @@ Bases: [`BasePage`](../page?id=basepage)
 Creates an RSS feed [Page](../page) Object.
 
 > !!! Note
-
     This is the base object type and should only contain the params identified by the standards defined in the [RSS 2.0 Specification](http://www.rssboard.org/rss-specification).
 
 This is built using the built-in `rss2.0.xml` jinja template.
 
 > !!! Note
-
     Some browsers may not support the `rss` extension. If you are having issues with your feed, try changing the extension to `xml`.
     ```Python
     from render_engine import Site, RSSFeed

diff --git a/docs/docs/page.md b/docs/docs/page.md
@@ -34,7 +34,6 @@ Returns the URL for the page including the first route.
 This gets the relative URL for a page.
 
 > !!! Note
-
     Pages don't have access to the Site attrs. You cannot get an abolute URL from a Page object.
     Use `{{SITE_URL}}` in your templates to get the absolute URL.
 
@@ -51,7 +50,6 @@ The general BasePage object used to make web pages.
 Pages can be rendered directly from a template or generated from a file.
 
 > !!! Note
-
     Not all attributes are defined by default (those that are marked optional) but will be checked for in other areas of the code.
 
 When you create a page, you specify variables passed into rendering template.

diff --git a/docs/docs/parsers.md b/docs/docs/parsers.md
@@ -80,7 +80,6 @@ You can create custom parsers.
 All the staticmethods for parsers should return a tuple where the first entry is a dictionary of attributes and the second entry is the rendered content.
 
 > !!! Warning
-
     Custom Parsers do not use frontmatter by default. You would need to ensure that your parser handles frontmatter if you want to use it.
 
 For example, to create a parser that renders a dictionary, you could do the following: