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

Use standard markdown header syntax #901

Closed
Jamie-SA opened this issue Jun 27, 2023 · 1 comment · Fixed by #1028
Closed

Use standard markdown header syntax #901

Jamie-SA opened this issue Jun 27, 2023 · 1 comment · Fixed by #1028
Assignees

Comments

@Jamie-SA
Copy link
Contributor

I'd like to suggest switching our markdown style to use standard markdown syntax for headers. By this I mean the use of "#" on the title line versus the use of "====" and "----" on the line under it. AFAIK this is the original syntax and I've seen it as the recommended syntax (on some markdown site that I don't remember off the top of my head).

  • It is the recommended syntax
  • It uses less lines
  • It is more uniform when going beyond 2 levels of headers
@rjyounes
Copy link
Collaborator

rjyounes commented Jun 28, 2023

I don't think the pros are particularly compelling, but I don't really care either way; I had chosen that style pretty much at random. We should change the existing markdown files and update .markdownlint.json accordingly.

@rjyounes rjyounes self-assigned this Aug 24, 2023
@rjyounes rjyounes moved this to To do (typically assigned) in gist Version 12.1.0 Nov 19, 2023
@rjyounes rjyounes moved this from To Do to In Progress in gist Version 12.1.0 Feb 2, 2024
@rjyounes rjyounes moved this from In Progress to In Review in gist Version 12.1.0 Feb 4, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in gist Version 12.1.0 Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants