Added information on Markdown syntax

Hello,

In the Markdown Guide that Joplin offers (very complete by the way!), I would like to add a section about Heading IDs.

On Joplin I did several tests and here are my conclusions:
Please excuse the English mistakes, I am French and not being good in English I use a translator.

To create an internal link to a note, like a summary I do :

## Purposes:

This is a text at the beginning of a note to give its object, its role or any other thing.

 ---
 
 ## Summary: 
 
 1. [Introduction](#introduction)
2. [Axis 1](#axis-1-theme)
 3. [Axis 2](#name-axis-2-extension)
 4. [Axis 3](#title-axis-3)
 5. [Conclusion](#conclusion)

---

# Introduction:

This is an introduction all that there is of more banal, there we introduce our subject.
We don't have to specify the objectives because we put them at the top of the note :) 

Blah blah 
Bla bla 
Bla bla 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Axis 1 theme:

Here we're going to do some blah blah on our first theme.

Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Name Axis 2 (extension) 

Here I did not put the " : " after 'Name Axis 2' to show that it is not mandatory to put them in the link of the summary.

Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Title Axis 3 :

Return [Summary](#summary).
You can make a link to the summary when the note is long.

Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Conclusion

In summary what I understood:
* The link in the summary should not contain :
	* brackets
	* apostrophes
	* capital letters 
	* spaces
* The link reference must be a title with a # or any other way to declare a title

If you have a better or simpler method, I'm interested!

Moreover for the people speaking with a language having accented characters, one can put them in the links of the summary.
Example:

7. [Résumé](#résumé)


Bla bla 
Bla bla 
...
Bla bla 
Bla bla 


# Résumé :

Bla bla

I found something new!
Less configurable than the one I just explained but easier.
The idea is to write [TOC] instead of the summary.
These simple characters create a table with all the titles and their links.

This gives :

## Purposes:
This is a text at the beginning of a note to give its object, its role or any other thing.


 ---
 
 ## Summary: 
 
[TOC]

---

# Introduction:

this is an introduction all that there is of more banal, there we introduce our subject.
We don't have to specify the objectives because we put them at the top of the note :) 

Blah blah 
Bla bla 
Bla bla 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Axis 1 theme:

Here we're going to do some blah blah on our first theme.

Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Name Axis 2 (extension) 

Here I did not put the " : " after 'Name Axis 2' to show that it is not mandatory to put them in the link of the summary.

Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Title Axis 3 :

Return [Summary](#summary).
You can make a link to the summary when the note is long.

Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 
Blah blah 

# Conclusion
In summary what I understood:
* The link in the summary should not contain :
	* brackets
	* apostrophes
	* capital letters 
	* spaces
* The link reference must be a title with a # or any other way to declare a title

Also take a look at the outline plugin, so you don't have to write [toc] in to the note.

2 Likes

Thank you for this extension that will put of great use!

What I wrote is still a bit useful if we want to export our notes to PDF for example. The links in the documents are still available.

yes, this is true

The solutions in this Topic are:

  • If you want a note that will be exported (for example in PDF) and keep its internal links you can :

    • totally customize them by reading this message

    • you can use [TOC] which will display all the titles in the summary (reference to this message )

  • If you want to be able to navigate better in your note and not make a summary in case of export use the outline plugin (reference to this message 1 and 2)

Just out of curiosity, do you know any other words like [TOC]?

I discovered this word while editing a Joplin note with the external editor Typora who uses this word to make his table of contents.
I was wondering if there are other magic words like this?

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.