Switch to the MyST documentation system
See original GitHub issueMyST allows you to write Sphinx documentation entirely in markdown.
Here is a breakdown of the files that need to be converted:
The RST files under {{cookiecutter.project_name}}
:
- The README
- The Contributor Guide
- The Code of Conduct. Use the original Markdown version provided by the Contributor Covenant.
- The licenses. Should we use the original plain text versions?
The RST files under {{cookiecutter.project_name}}/docs
:
- The wrapper files: codeofconduct.rst, contributing.rst, license.rst
- The API reference: reference.rst
- The command-line reference: usage.rst
- The index: index.rst
Converting the Cookiecutter’s own documentation is tracked in a separate issue, see #1080.
Issue Analytics
- State:
- Created 3 years ago
- Reactions:1
- Comments:9 (9 by maintainers)
Top Results From Across the Web
MyST-Parser - Read the Docs
A Sphinx and Docutils extension to parse MyST, a rich and extensible flavour of Markdown for authoring technical and scientific documentation.
Read more >[TechDocs] MyST and/or Sphinx support · Issue #8642 - GitHub
I know in documentation say currently just support markdown as built on MkDocs, but wondering if possible plans for MyST support ...
Read more >Switch recommonmark to myst-parser - LLVM Discourse
At some point fairly recently recommonmark has been introduced into the clang/docs for the life of me I can no longer build the...
Read more >MyST Markdown editor component for easier collaboration
Svevn's documentation work predominantly relies on Sphinx - a well-established documentation system that allows us to generate both PDF and ...
Read more >Sphinx, MyST, and Python Docs in 2022 - YouTube
Sphinx, MyST, and Python Docs in 2022 - Talk Python Episode #354. Watch later. Share. Copy link ... Switch camera. Share. Include playlist....
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Yep, that make sense! I can continue to convert other files under the doc to markdown. If you have any comments please free feel to tell me. It is my pleasure to contribute this project 😎
Updated the issue description with a breakdown of the files that need to converted.