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 files should have title level 2 only #642

Closed
MoOx opened this issue Feb 26, 2016 · 4 comments
Closed

Markdown files should have title level 2 only #642

MoOx opened this issue Feb 26, 2016 · 4 comments

Comments

@MoOx
Copy link
Member

MoOx commented Feb 26, 2016

Currently it seems we have some files that have some level 1 but they should not.

I see two solutions:

  • add a linter that yell on level 1
  • transform level 1 to 2, 2 to 3 etc (via remark/mdast).

I think the automatic solution make more sense for a good UX.

@magsout
Copy link
Collaborator

magsout commented Mar 4, 2016

Linter is better IMO. force user to make goood code..

@magsout
Copy link
Collaborator

magsout commented Mar 4, 2016

And especially why. The linter explains why the code is not good.

@MoOx
Copy link
Member Author

MoOx commented Mar 4, 2016

Yeah but maybe enhancing UX by converting level to what we need is even better (and starting with level 2 in post is a bit weird to be honest).

@bloodyowl
Copy link
Member

turbo osef

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

No branches or pull requests

3 participants