Skip to content

Improve style in Markdown files #18

Description

@jhlegarreta

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.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions