summaryrefslogtreecommitdiff
path: root/public/docs/features.md
diff options
context:
space:
mode:
authoroupala2020-07-01 11:52:17 +0200
committeroupala2020-07-10 18:57:59 +0200
commit2f462f90d4608763e5cb9618ec80d939a679fe2e (patch)
tree0f13c88084116c53edfd0752576b7f596b5d8030 /public/docs/features.md
parent73219909602e026616af6a97f588bc9e0eab1fa8 (diff)
style: linting markdown files
Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
Diffstat (limited to 'public/docs/features.md')
-rw-r--r--public/docs/features.md70
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