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

Coding style for markdown files #119

Open
jiskattema opened this issue Jan 23, 2018 · 2 comments
Open

Coding style for markdown files #119

jiskattema opened this issue Jan 23, 2018 · 2 comments

Comments

@jiskattema
Copy link

Our markdown files do not follow a coding style themselves, and look quite messy.

  • Do we have a newline after each header?
  • Newline after a line ending ([.?!]), or do we wrap at 80 characters (this is actually happening at places. i approve of this fortran70 inspired behaviour, but would not use it here ;)
@jiskattema
Copy link
Author

is there a linter for markdown?
Some quick searching gives https://github.com/remarkjs/remark-lint

@egpbos
Copy link
Member

egpbos commented Oct 20, 2023

Perhaps some short suggestions could be written down, although I'm afraid they won't be adhered to much, and it also doesn't feel completely like our business to say too much on this, since I wouldn't technically call it software (although I admit it's a gray area); MarkDown is primarily a markup language, as well as HTML and LaTeX, and so the rendering is more important than the source and gets the most attention. Should we also give suggestions on how to write those? I'm not completely convinced. Also, there's a big risk that many rules are opinionated.

Like with #54, I would suggest that if someone wants to pick this up, they first do a bit more research into what good practices are out there for markup languages in general (let's not do MarkDown only). Then try to brainstorm about it with a few people (preferably with different opinions) and see if you can get to some agreement. Don't write the chapter text yet, first discuss it here, so we can decide whether this should become a chapter or not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants