4 ms·

Not sure how useful are footnotes but the lack of ability to assign stable ID to headers is annoying. Something like: ###|about What is all this about? A

Not sure how useful are footnotes but the lack of ability to assign stable ID to headers is annoying. Something like: ###|about What is all this about? And #2 in wish list is built-in support for `<details>` - collapsible sections - quite useful in documentation.

mstade 5y ago
The details html tag works fine on GitHub; or did you mean you’d like a new syntax that’s more markdownesque? EDIT: Definite +1 for the stable headers id suggestion. I implemented something similar in a proof of concept app a while back, but it was a suffix rather than a prefix, in brackets, like so: # About this project { #about } It worked really well, and the syntax allowed for additional properties like css like class syntax. Thouh we referred to them as tags because they were used to tag sections, paragraphs etc., so we could do some interesting aggregation later on.
- c-smile 5y ago
  I would rather define some MD rule for <DL><DT><DD> and ask viewers to use collapsing ### Properties + #### innerHTML Get/set inner HTML content + #### innerText Get/set content as text ### Methods
  - mstade 5y ago
    We did something similar to this, but used ~ instead, like so: ~ Definition title The definition data should be indented at the same level as the title. This let's you nest definitions also: ~ Like this Here's a nested definition. We also allowed : instead of ~ but most people seemed to prefer the latter. We didn't collapse anything in rendering though, but it's not a bad idea. The resulting markup when rendered to HTML was actual definition lists (<dl>) though, not details, so that'd either have to be done by nesting details or css magic I suppose.
erdo 5y ago
Not sure if this helps you, and you may already be aware of it, but in my gitHub pages markdown I have titles like these: ## <a name="boiler-plate"></a>Removing more boiler plate
- erdo 5y ago
  I just read that using "id" is the preferred way (see the other reply) "name" is deprecated for this use, but it still works of course (I'm not a web developer, been using the same markdown trick for years)
CyberShadow 5y ago
You can already do this with HTML, if you want to: ### <a id="about"></a>What is all this about?
- c-smile 5y ago
  In your case id is assigned to wrong element. So to use <h3 id=about>What is all this about?</h3> But what's the point of using MD then?
  - maddyboo 5y ago
    It’s the “wrong element” but if the goal is to scroll to a given vertical position then it works.
toastal 5y ago
You could choose AsciiDoc instead which lets you choose your own IDs and is supported on GitHub and GitLab

mstade 5y ago

The details html tag works fine on GitHub; or did you mean you’d like a new syntax that’s more markdownesque? EDIT: Definite +1 for the stable headers id suggestion. I implemented something similar in a proof of concept app a while back, but it was a suffix rather than a prefix, in brackets, like so: # About this project { #about } It worked really well, and the syntax allowed for additional properties like css like class syntax. Thouh we referred to them as tags because they were used to tag sections, paragraphs etc., so we could do some interesting aggregation later on.

c-smile 5y ago
I would rather define some MD rule for <DL><DT><DD> and ask viewers to use collapsing ### Properties + #### innerHTML Get/set inner HTML content + #### innerText Get/set content as text ### Methods
- mstade 5y ago
  We did something similar to this, but used ~ instead, like so: ~ Definition title The definition data should be indented at the same level as the title. This let's you nest definitions also: ~ Like this Here's a nested definition. We also allowed : instead of ~ but most people seemed to prefer the latter. We didn't collapse anything in rendering though, but it's not a bad idea. The resulting markup when rendered to HTML was actual definition lists (<dl>) though, not details, so that'd either have to be done by nesting details or css magic I suppose.

erdo 5y ago

Not sure if this helps you, and you may already be aware of it, but in my gitHub pages markdown I have titles like these: ## <a name="boiler-plate"></a>Removing more boiler plate

erdo 5y ago
I just read that using "id" is the preferred way (see the other reply) "name" is deprecated for this use, but it still works of course (I'm not a web developer, been using the same markdown trick for years)

CyberShadow 5y ago

You can already do this with HTML, if you want to: ### <a id="about"></a>What is all this about?

c-smile 5y ago
In your case id is assigned to wrong element. So to use <h3 id=about>What is all this about?</h3> But what's the point of using MD then?
- maddyboo 5y ago
  It’s the “wrong element” but if the goal is to scroll to a given vertical position then it works.

toastal 5y ago

You could choose AsciiDoc instead which lets you choose your own IDs and is supported on GitHub and GitLab