status-im/codimd
2
0
Fork 0
mirror of https://github.com/status-im/codimd.git synced 2025-02-20 18:28:25 +00:00
Code Issues Projects Releases Wiki Activity

added documentation to features.md

Browse Source 
Signed-off-by: Gereon Dusella <git@gereondusella.de>
This commit is contained in:
Gereon Dusella 2020-06-03 20:40:23 +02:00
parent 1248bc9cd4
commit c7013574e2
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
public/docs/features.md
View File

@ -82,7 +82,8 @@ View
## Table of Contents: ## Table of Contents:
You can look at the bottom right section of the view area, there is a _ToC_ button <i class="fa fa-bars"></i>. You can look at the bottom right section of the view area, there is a _ToC_ button <i class="fa fa-bars"></i>.
Pressing that button will show you a current _Table of Contents_, and will highlight which section you're at. Pressing that button will show you a current _Table of Contents_, and will highlight which section you're at.
ToCs support up to **three header levels**. ToCs support up to **five header levels**, the **default** is **set to three**. The maxLevel can be set for each note by using
[YAML Metadata](./yaml-metadata)
## Permalink ## Permalink
Every header will automatically add a permalink on the right side. Every header will automatically add a permalink on the right side.
@ -133,12 +134,19 @@ You can provide advanced note information to set the browser behavior (visit abo
- GA: set to use Google Analytics - GA: set to use Google Analytics
- disqus: set to use Disqus - disqus: set to use Disqus
- slideOptions: setup slide mode options - slideOptions: setup slide mode options
- toc: set options of the Table of Contents.
## ToC: ## ToC:
Use the syntax `[TOC]` to embed table of content into your note. Use the syntax `[TOC]` to embed table of content into your note. By default, three header levels are displayed. This can also be specified by using [YAML Metadata](./yaml-metadata).
[TOC] [TOC]
You can also specify the number of header levels by specifying the `maxLevel` like this: `[TOC maxLevel=1]`
[TOC maxLevel=1]
## Emoji ## Emoji
You can type any emoji like this :smile: :smiley: :cry: :wink: You can type any emoji like this :smile: :smiley: :cry: :wink:
> See full emoji list [here](http://www.emoji-cheat-sheet.com/). > See full emoji list [here](http://www.emoji-cheat-sheet.com/).