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 style in Markdown files #18

Open
jhlegarreta opened this issue Aug 2, 2023 · 0 comments
Open

Improve style in Markdown files #18

jhlegarreta opened this issue Aug 2, 2023 · 0 comments

Comments

@jhlegarreta
Copy link
Contributor

Current Markdown are hard to read. It would be nice if we increased consistency:

  • Using dashes or asterisks for lists, but avoid using both.
  • Typically, dashes under headings require the former to cover the entire length of the heading characters. Otherwise, the heading may not be displayed correctly. Changing them for prefix hashtags can be simpler.

Also, limiting the line length to e.g. 79 characters would greatly improve readability.

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

1 participant