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

Markdown style guide: Improvements #230

Open
jpmckinney opened this issue Sep 19, 2020 · 0 comments
Open

Markdown style guide: Improvements #230

jpmckinney opened this issue Sep 19, 2020 · 0 comments

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Sep 19, 2020

Change this style guide's page to .md and enable the MyST-Parser extension.

  • Document how to link to within-page headings
  • Front Matter: Document when/how to mark orphan pages
  • Directives:
    • When to use different admonitions, e.g. note, tip, see also, caution like on https://jupyterbook.org/content/myst.html
    • Use literalinclude instead of jsoninclude, if jsonpointer is empty
    • Document when to use csv-table-no-translate (and any other directives involved in translation)
    • Check for use of other directives to document
  • Demonstrate MyST-Parser's key features
    • Mainly the directive syntax, including an example of a code-block inside another directive
@jpmckinney jpmckinney changed the title Style guide: When do use different admonitions, etc. Style guide: When to use different admonitions, etc. Sep 19, 2020
@jpmckinney jpmckinney changed the title Style guide: When to use different admonitions, etc. Markdown style guide Jun 17, 2021
@jpmckinney jpmckinney changed the title Markdown style guide Markdown style guide: Improvements Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant