Jigsaw: Table of Contents

Created on 5 Jan 2019  路  2Comments  路  Source: tighten/jigsaw

Hi Jigsaw team,

I'm used to the read the docs tool to write Markdown to create documentation. However, I'm enjoying this tool and we decide to use it at my work palce.

Inside a markdown file, right after the main title at the top, I can insert [TOC] and mkdocs will parse all the # inside the file markdown starting with ## since the title of the markdown file is #; just a way to not to include the title in the table of contents.

It is a way to create TOC with jigsaw?

Most helpful comment

Another markdown notation that the current markdown parser doesn't do is special notes. When you do the following...

!!!note
    This is a special note.

!!!info
    This is a special info.

!!!warning
    This is a special warning.

!!!danger
    This is a special danger.

Some markdown parsers create a markup like this...

<note>
    <header>Note</header>
    <p>This is a special note.</p>
</note>
<br>
<info>
    <header>Info</header>
    <p>This is a special info.</p>
</info>
<br>
<warning>
    <header>Warning</header>
    <p>This is a special warning.</p>
</warning>
<br>
<danger>
    <header>Danger</header>
    <p>This is a special danger.</p>
</danger>

With a style that looks like this...

screen shot 2019-01-07 at 11 19 26 am

Since the current markdown parser doesn't do it, at my workplace we are using just html to credate the markup and added the tailwin css to make it happen.

I'm wondering if that is something you would like to pr.

All 2 comments

Hey @diazgilberto,
There isn't right now, but that's a really clever idea.

It's certainly possible! But we don't have it as a feature yet.

Another markdown notation that the current markdown parser doesn't do is special notes. When you do the following...

!!!note
    This is a special note.

!!!info
    This is a special info.

!!!warning
    This is a special warning.

!!!danger
    This is a special danger.

Some markdown parsers create a markup like this...

<note>
    <header>Note</header>
    <p>This is a special note.</p>
</note>
<br>
<info>
    <header>Info</header>
    <p>This is a special info.</p>
</info>
<br>
<warning>
    <header>Warning</header>
    <p>This is a special warning.</p>
</warning>
<br>
<danger>
    <header>Danger</header>
    <p>This is a special danger.</p>
</danger>

With a style that looks like this...

screen shot 2019-01-07 at 11 19 26 am

Since the current markdown parser doesn't do it, at my workplace we are using just html to credate the markup and added the tailwin css to make it happen.

I'm wondering if that is something you would like to pr.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Wulfheart picture Wulfheart  路  4Comments

dgursh picture dgursh  路  4Comments

Log1x picture Log1x  路  8Comments

DRogueRonin picture DRogueRonin  路  8Comments

GenieTim picture GenieTim  路  4Comments