Skip to content

Navigation Menu

Sign in
Sign up

Convert to Markdown #105

Open
Open

Description

This is a proposal to convert the documentation to Markdown since many people are familiar with it (myself included) but are not familiar with ReStructuredText. Personally I don't have the time nor interest in learning another markup language when Markdown is the standard on GitHub. As a result, I have not been involved with the documentation lately.

https://hellosystem.github.io/docs/ uses Sphinx, recommonmark, and GitHub Actions to produce documentation from the Markdown source files in this repository: https://github.com/helloSystem/docs

Maybe we can use a similar tooling for this documentation?

NOTE: recommonmark is now deprecated. Its developers recommend using MyST for a docutils bridge going forward. See this issue for background and discussion.

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

      AltStyle によって変換されたページ (->オリジナル) /