Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider switching documentation to MyST markdown #1378

Open
choldgraf opened this issue Sep 12, 2020 · 0 comments
Open

Consider switching documentation to MyST markdown #1378

choldgraf opened this issue Sep 12, 2020 · 0 comments
Labels

Comments

@choldgraf
Copy link
Contributor

MyST Markdown is a new flavor of markdown that provides all of Sphinx's functionality from within Markdown (as opposed to reStructuredText). You can do anything in MyST markdown that you can do in rST with Sphinx. I've found that it makes documentation much more pleasant to write, and also much easier for others to contribute to since markdown is more commonly-known than rST.

Also of note is that rST and MyST markdown can co-exist...there's no need to switch entirely from one to the other.

How do folks feel about moving a few pages of the nbconvert docs to MyST markdown to see how it looks. We can treat that as a pilot to then decide whether to begin a broader migration to MyST over time.

cc @willingc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants