From 16de3cb21bd813b00e36989ef9dff8da19f040ac Mon Sep 17 00:00:00 2001 From: John Aziz Date: Tue, 22 Oct 2024 21:57:55 +0300 Subject: [PATCH 1/4] Fix Markdown Line Length --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e062349..b677d10 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,29 @@ # Render Engine `BasePageParser` -The `BasePageParser` is used for making content for Render Engine. Parsers are used to parse the content of a page and convert it to HTML. The parser is specified in the page attributes as `Parser`. +The `BasePageParser` is used for making content for Render Engine. Parsers are +used to parse the content of a page and convert it to HTML. The parser is +specified in the page attributes as `Parser`. -This is meant to be used by Render Enging but can be used as a base dependency for building custom Render Engine Parsers. +This is meant to be used by Render Enging but can be used as a base dependency +for building custom Render Engine Parsers. ## Using Frontmatter -[Frontmatter](https://github.com/eyeseast/python-frontmatter) is used to pull in attributes from a generated page. +[Frontmatter](https://github.com/eyeseast/python-frontmatter) is used to pull +in attributes from a generated page. -Some pages will be looking for information that is provided in the frontmatter. All of the attributes defined can be used in the template (which itself can also be defined in the frontmatter or the class itself. +Some pages will be looking for information that is provided in the frontmatter. +All of the attributes defined can be used in the template (which itself can +also be defined in the frontmatter or the class itself). > **NOTE** -> These attributes **CANNOT** be used in the content itself, but you can use them in the template generation. +> These attributes **CANNOT** be used in the content itself, but you can +> use them in the template generation. ## Parsing the Data -The base parser doesn't is a pass-thru parser meaning the content input will be passed through. +The base parser doesn't is a pass-thru parser meaning the content input will +be passed through. ```md --- From c0d2b1bcd6fc7dbf87d46353dec5d9dadbad7908 Mon Sep 17 00:00:00 2001 From: Ruff Date: Tue, 22 Oct 2024 18:58:46 +0000 Subject: [PATCH 2/4] Format and lint with Ruff --- .github/ISSUE_TEMPLATE/bug-report.md | 1 + .github/PULL_REQUEST_TEMPLATE.md | 3 +++ README.md | 2 +- 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 2748b08..87d000b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -11,6 +11,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '...' 3. See error diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 738f96b..8eb9171 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,13 @@ # Description + Please include a summary of the changes and the related issue. ## Checklist + - [ ] I have read the contributing guidelines. - [ ] I have written tests for the changes, if applicable. - [ ] I have added necessary documentation. ### Related Issues + Please reference related issues here: diff --git a/README.md b/README.md index b677d10..a54c456 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Render Engine `BasePageParser` The `BasePageParser` is used for making content for Render Engine. Parsers are -used to parse the content of a page and convert it to HTML. The parser is +used to parse the content of a page and convert it to HTML. The parser is specified in the page attributes as `Parser`. This is meant to be used by Render Enging but can be used as a base dependency From e714e79ac1ea8d68dc91d160b4d8019f0bd85b1a Mon Sep 17 00:00:00 2001 From: John Aziz Date: Sat, 26 Oct 2024 14:23:57 +0000 Subject: [PATCH 3/4] ignore line length rule --- .markdownlint.json | 4 ++++ README.md | 20 ++++++-------------- 2 files changed, 10 insertions(+), 14 deletions(-) create mode 100644 .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..8081267 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD013": false, + "MD041": false +} diff --git a/README.md b/README.md index a54c456..e062349 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,21 @@ # Render Engine `BasePageParser` -The `BasePageParser` is used for making content for Render Engine. Parsers are -used to parse the content of a page and convert it to HTML. The parser is -specified in the page attributes as `Parser`. +The `BasePageParser` is used for making content for Render Engine. Parsers are used to parse the content of a page and convert it to HTML. The parser is specified in the page attributes as `Parser`. -This is meant to be used by Render Enging but can be used as a base dependency -for building custom Render Engine Parsers. +This is meant to be used by Render Enging but can be used as a base dependency for building custom Render Engine Parsers. ## Using Frontmatter -[Frontmatter](https://github.com/eyeseast/python-frontmatter) is used to pull -in attributes from a generated page. +[Frontmatter](https://github.com/eyeseast/python-frontmatter) is used to pull in attributes from a generated page. -Some pages will be looking for information that is provided in the frontmatter. -All of the attributes defined can be used in the template (which itself can -also be defined in the frontmatter or the class itself). +Some pages will be looking for information that is provided in the frontmatter. All of the attributes defined can be used in the template (which itself can also be defined in the frontmatter or the class itself. > **NOTE** -> These attributes **CANNOT** be used in the content itself, but you can -> use them in the template generation. +> These attributes **CANNOT** be used in the content itself, but you can use them in the template generation. ## Parsing the Data -The base parser doesn't is a pass-thru parser meaning the content input will -be passed through. +The base parser doesn't is a pass-thru parser meaning the content input will be passed through. ```md --- From d1066f1f19ded38987416452c7e40b2b9c7b0e3b Mon Sep 17 00:00:00 2001 From: John Aziz Date: Sat, 26 Oct 2024 14:25:40 +0000 Subject: [PATCH 4/4] unignore first line rule --- .markdownlint.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.markdownlint.json b/.markdownlint.json index 8081267..1344b31 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,4 +1,3 @@ { - "MD013": false, - "MD041": false + "MD013": false }