Skip to content

README.md using markup instead of markdown #16

@pmaciel

Description

@pmaciel

There is now a lot of markup in the (markdown) README.md across many projects, specifically Earthkit.

The point of markdown is to have still-readable text content regardless of the rendering. Quoting from daringfireball who started the markdown initiative, objectives are:

  • Simplify writing: Provide an easy-to-read, easy-to-write plain text format.
  • Enable formatting: Allow text formatting (e.g., headings, lists, links) without complex syntax.
  • Support portability: Be usable across platforms, converting to HTML or other formats.
  • Improve readability: Make documents readable in raw form.
  • Facilitate collaboration: Work well in version-controlled environments like Git.

There's now logic to detech white or black background -- that's really excessive. Let's improve this?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions