diff options
author | David Mehren | 2020-07-10 19:59:32 +0200 |
---|---|---|
committer | GitHub | 2020-07-10 19:59:32 +0200 |
commit | 3db8b0df43b027d15d13047e25617266ddc57f13 (patch) | |
tree | da64f90f7cd4ab4c1deaf67a572a45c2a583dc7e /public/docs/features.md | |
parent | 0b7dbd1f43899b4321ddf41bf98a64a7bd5fa48d (diff) | |
parent | 89895cef2e5785134bf1fdcc9c8813831c07f17b (diff) |
Merge pull request #410 from oupala/feature/markdown-linting
Diffstat (limited to 'public/docs/features.md')
-rw-r--r-- | public/docs/features.md | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/public/docs/features.md b/public/docs/features.md index 888cac10..5f1d8415 100644 --- a/public/docs/features.md +++ b/public/docs/features.md @@ -4,9 +4,9 @@ <i class="fa fa-file-text"></i> **CodiMD** is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your **desktop**, **tablet** or even on the **phone**. -You can sign-in via multiple auth providers like **Facebook**, **Twitter**, **GitHub** and many more on the [_homepage_](/). +You can sign-in via multiple auth providers like **Facebook**, **Twitter**, **GitHub** and many more on the [*homepage*](/). -If you experience any _issues_, feel free to report it on [**GitHub**](https://github.com/codimd/server/issues). +If you experience any *issues*, feel free to report it on [**GitHub**](https://github.com/codimd/server/issues). Or meet us on [**Matrix.org**](https://riot.im/app/#/room/#codimd:matrix.org) for dev-talk and interactive help. **Thank you very much!** @@ -50,21 +50,21 @@ Currently, you can save to **Dropbox** <i class="fa fa-dropbox"></i> (depending ### Import Notes -Similarly to the _save_ feature, you can also import a Markdown file from **Dropbox** <i class="fa fa-dropbox"></i> (depending on the instance's configuration), or import content from your **clipboard** <i class="fa fa-clipboard"></i>, which can parse some HTML. :smiley: +Similarly to the *save* feature, you can also import a Markdown file from **Dropbox** <i class="fa fa-dropbox"></i> (depending on the instance's configuration), or import content from your **clipboard** <i class="fa fa-clipboard"></i>, which can parse some HTML. :smiley: ### Permissions It is possible to change the access permission of a note through the little button on the top right of the view. There are four possible options: -| |Owner read/write|Signed-in read|Signed-in write|Guest read|Guest write| -|:-----------------------------|:--------------:|:------------:|:-------------:|:--------:|:---------:| -|<span class="text-nowrap"><i class="fa fa-leaf fa-fw"></i> **Freely**</span>|✔|✔|✔|✔|✔| -|<span class="text-nowrap"><i class="fa fa-pencil fa-fw"></i> **Editable**</span>|✔|✔|✔|✔|✖| -|<span class="text-nowrap"><i class="fa fa-id-card fa-fw"></i> **Limited**</span>|✔|✔|✔|✖|✖| -|<span class="text-nowrap"><i class="fa fa-lock fa-fw"></i> **Locked**</span>|✔|✔|✖|✔|✖| -|<span class="text-nowrap"><i class="fa fa-umbrella fa-fw"></i> **Protected**</span>|✔|✔|✖|✖|✖| -|<span class="text-nowrap"><i class="fa fa-hand-stop-o fa-fw"></i> **Private**</span>|✔|✖|✖|✖|✖| +| | Owner read/write | Signed-in read | Signed-in write | Guest read | Guest write | +|:------------------------------------------------------------------------------------ |:----------------:|:--------------:|:---------------:|:----------:|:-----------:| +| <span class="text-nowrap"><i class="fa fa-leaf fa-fw"></i> **Freely**</span> | ✔ | ✔ | ✔ | ✔ | ✔ | +| <span class="text-nowrap"><i class="fa fa-pencil fa-fw"></i> **Editable**</span> | ✔ | ✔ | ✔ | ✔ | ✖ | +| <span class="text-nowrap"><i class="fa fa-id-card fa-fw"></i> **Limited**</span> | ✔ | ✔ | ✔ | ✖ | ✖ | +| <span class="text-nowrap"><i class="fa fa-lock fa-fw"></i> **Locked**</span> | ✔ | ✔ | ✖ | ✔ | ✖ | +| <span class="text-nowrap"><i class="fa fa-umbrella fa-fw"></i> **Protected**</span> | ✔ | ✔ | ✖ | ✖ | ✖ | +| <span class="text-nowrap"><i class="fa fa-hand-stop-o fa-fw"></i> **Private**</span> | ✔ | ✖ | ✖ | ✖ | ✖ | **Only the owner of the note can change the note's permissions.** @@ -88,8 +88,8 @@ To switch the editor into slide mode, set the [document type](./yaml-metadata#ty ### Autogenerated 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>. -Pressing that button will show you a current _Table of Contents_, and will highlight which section you're at. +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. ToCs support up to **three header levels**. ### Permalink @@ -127,7 +127,7 @@ The first **level 1 heading** (e.g. `# Title`) will be used as the note title. Using tags as follows, the specified tags will show in your **history**. -###### tags: `features` `cool` `updated` +#### tags: `features` `cool` `updated` ### [YAML Metadata](./yaml-metadata) @@ -246,7 +246,7 @@ When you’re a carpenter making a beautiful chest of drawers, you’re not goin #### PDF **Caution: this might be blocked by your browser if not using an `https` URL.** -{%pdf https://papers.nips.cc/paper/5346-sequence-to-sequence-learning-with-neural-networks.pdf %} +{%pdf <https://papers.nips.cc/paper/5346-sequence-to-sequence-learning-with-neural-networks.pdf> %} ### MathJax @@ -492,41 +492,41 @@ console.log(foo(5)); #### Tables -| Option | Description | -| ------ | ----------- | +| Option | Description | +| ------ | ------------------------------------------------------------------------- | | data | path to data files to supply the data that will be passed into templates. | -| engine | engine to be used for processing templates. Handlebars is the default. | -| ext | extension to be used for dest files. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | Right aligned columns -| Option | Description | -| ------:| -----------:| -| data | path to data files to supply the data that will be passed into templates. | -| engine | engine to be used for processing templates. Handlebars is the default. | -| ext | extension to be used for dest files. | +| Option | Description | +| ------:| -------------------------------------------------------------------------:| +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | Left aligned columns -| Option | Description | -|:------ |:----------- | +| Option | Description | +|:------ |:------------------------------------------------------------------------- | | data | path to data files to supply the data that will be passed into templates. | -| engine | engine to be used for processing templates. Handlebars is the default. | -| ext | extension to be used for dest files. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | Center aligned columns -| Option | Description | -|:------:|:-----------:| -| data | path to data files to supply the data that will be passed into templates. | -| engine | engine to be used for processing templates. Handlebars is the default. | -| ext | extension to be used for dest files. | +| Option | Description | +|:------:|:-------------------------------------------------------------------------:| +| data | path to data files to supply the data that will be passed into templates. | +| engine | engine to be used for processing templates. Handlebars is the default. | +| ext | extension to be used for dest files. | #### Links [link text](https://demo.codimd.org) [link with title](https://nodeca.github.io/pica/demo/ "title text!") -Autoconverted link https://github.com/nodeca/pica +Autoconverted link <https://github.com/nodeca/pica> #### Images @@ -569,7 +569,7 @@ Term 2 with *inline markup* Third paragraph of definition 2. -_Compact style:_ +*Compact style:* Term 1 ~ Definition 1 |