Merge pull request #3 from render-engine/move-readme-to-main

moves readme to the root

Author: kjaymiller

.github/workflows/lint.yml

@@ -24,8 +24,8 @@ jobs:
       # Update output format to enable automatic inline annotations.
       - name: Run Ruff
         run: |
-            ruff check --fix --output-format=github render_engine_makrdown
-            ruff format render_engine_makrdown
+            ruff check --fix --output-format=github render_engine_markdown
+            ruff format render_engine_markdown
 
       - name: Markdown Lint base-files
         uses: DavidAnson/markdownlint-cli2-action@v14

CODE_OF_CONDUCT.md

@@ -59,7 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at [email protected].
+reported to the community leaders responsible for enforcement at <[email protected]>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -128,4 +128,4 @@ For answers to common questions about this code of conduct, see the FAQ at
 [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
+[translations]: https://www.contributor-covenant.org/translations

render_engine_markdown/README.md renamed to README.md

@@ -13,9 +13,9 @@ class MarkdownPageParser(BasePageParser):
     """
 
     @staticmethod
-    def parse(content: str, extras: dict[str, any] | None = None ) -> str:
+    def parse(content: str, extras: dict[str, any] | None = None) -> str:
         """Parses the content with the parser"""
         return markdown(
             content,
             extras=extras.get("markdown_extras", []) if extras else [],
-            )
+        )