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

Markdown formatting adjustments #228

Merged

Conversation

lifehackerhansol
Copy link
Contributor

Things that happen in this PR:

  • Clean up ordered lists, standardize to using 1.
  • Clean up indents, default to 4-space indents
  • Clean up unordered lists, standardize to using -
  • Convert most <a> tags to Markdown links
    • Leave the download tags alone, as those are still needed for those particular cases

Needed on systems that enforce PEP668
Following specifications at [0] the formatting for lists "have no
effect on the HTML output Markdown produces".

This means we can consolidate all ordered lists to `1.`, which makes it
easier for the end user to add and remove steps and retain the
numbering.

It should be noted some Markdown implementations may use the first
number as a starting number for ordered lists, so it's best to start
with `1.`.

[0]: https://daringfireball.net/projects/markdown/syntax#list
There is a mix of tabs, 4-space and 6-space indents; standardize
indentation across all pages to 4-spaces to keep consistency.
Standardize the unordered list marker to `-`, which is currently the
most widely used form of indentation in this repository.
@MarigoldZephyrNio MarigoldZephyrNio merged commit 30ff537 into nh-server:master Sep 29, 2024
1 check passed
@lifehackerhansol lifehackerhansol deleted the markdown-formatting branch September 29, 2024 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants