Skip to content
This repository has been archived by the owner on Apr 22, 2020. It is now read-only.

Simplify heading syntax #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

stefanv
Copy link
Collaborator

@stefanv stefanv commented Sep 25, 2017

The heading specification in this proposal still strikes me as still being quite complicated to memorize. We can consider the {} syntax for adding class attributes, as introduced by Markdown extra and outlined in this PR.

Note that Markdown Extra also allows the {} syntax proposed by Myst for extra image attributes (they also allow its use on links).

- `^`, for subsubsections (maps to `<h4 class="subsubsection">`)
- `"`, for paragraphs (maps to `<h5 class="paragraph">`)
- `'`, for paragraphs (maps to `<h6 class="paragraph">`)
* Only ATX (#-style) headings are used. The different levels, `#` through `######`, map to `h1` through `h6`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you suggesting to make this incompatible with rst?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not incompatible; just that RST would render title headings with {} as part of the text.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be fine, given that we will probably implemented Myst as a pre-processing step to RST.

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

Successfully merging this pull request may close these issues.

2 participants