Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve markdown formatting of pages, a lot of them are improperly formatted #2429

Merged
merged 26 commits into from Mar 23, 2024

Conversation

OniriCorpe
Copy link
Member

@OniriCorpe OniriCorpe commented Mar 1, 2024

Reverts #2428

Original PR: #2427

Problem

  • many pages are really improperly formatted 😅😅😅😅

Solution

  • i ran my markdown formater over all the pages and manually corrected a lot of things I could see
  • it'll deserve a second in-depth manual pass to replace the irrelevant in-line HTML
  • add .markdownlint.json to standardize the doc's markdown
  • add https://github.com/syseleven/markdownlint-rules-grav-pages to add grav special things to the automatic markdown lint, but it's just cloned in the repo, if someone know a better way of doing it, don't hesitate, plz <3

TODO

  • github action ou tests to lint PR

PR checklist

  • I'm not doing a PR for an application, I promise, I know that this kind of changes must go directly into the app packages themselves
  • PR finished and ready to be reviewed

@OniriCorpe

This comment was marked as outdated.

@OniriCorpe
Copy link
Member Author

uuuuh omg i readed the whole docs 3 times lmao 🙃😓😭

ready to review 🎉

@Psycojoker Psycojoker changed the title Revert "Revert "markdown format"" Improve markdown formatting of pages, a lot of them are improperly formatted Mar 12, 2024
@Psycojoker Psycojoker merged commit 7a01793 into master Mar 23, 2024
@Psycojoker Psycojoker deleted the revert-2428-revert-2427-markdown-format branch March 23, 2024 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants