Skip to content

doc: Fix Markdown doc markup issues #5075

@wenzeslaus

Description

@wenzeslaus

While the documentation is still build from HTML files. Markdown files are now in the source code and needed additional modifications (#5057, #5064). Feel free to grab a small issue or your favorite tool, and fix what is needed.

Identifiable by a text search:

  • Turn what was originally dt into headings or item lists as needed. (See where dt is in the .html file, fix the corresponding .md file.)

Identified by Markdown linting (delete the line from .markdownlint.yaml and fix what is needed):

Harder to identify:

Additional issues:

  • WARNING - Doc file 'imageryintro.md' contains a link 'band_references_scheme.png', but the target is not found among documentation files.
  • INFO - Doc file 'r.mapcalc.md' contains a link 'rasterintro.md#raster-format', but the doc 'rasterintro.md' does not contain an anchor '#raster-format'.

Additional info

The nice thing about Markdown is that many tools including GitHub can display it (or you even don't have to). If you want to build the resulting documentation anyway, see #5048.

The mkdocs build has some issues too. They are tracked in #5058.

The deployment of mkdocs and Markdown files for grass-addons are not yet tracked in separate issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Done

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions