mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-24 20:14:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

style: linting markdown files

Browse source 
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>
This commit is contained in:
oupala 2020-07-01 11:52:17 +02:00
parent 7321990960
commit 2f462f90d4
38 changed files with 1468 additions and 1358 deletions
Download patch file Download diff file Expand all files Collapse all files

70
public/docs/features.md
View file

@ -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

15
public/docs/privacy.md.example
View file

@ -1,14 +1,13 @@
Privacy
===
# Privacy
We process the following data, for the following purposes:
|your data|our usage|
|---------|---------|
|IP-Address|Used to communicate with your browser and our servers. It's may exposed to third-parties which provide resources for this service. These services are, depending on your login method, the document you visit and the setup of this instance: Google, Disqus, MathJax, GitHub, SlideShare/LinkedIn, yahoo, Libravatar, Imgur, Amazon, and Cloudflare.|
|Usernames and profiles|Your username as well as user profiles that are connected with it are transmitted and stored by us to provide a useful login integration with services like GitHub, Facebook, Twitter, GitLab, Dropbox, Google. Depending on the setup of this CodiMD instance there are maybe other third-parties involved using SAML, LDAP or the integration with a Mattermost instance.|
|Profile pictures| Your profile picture is either loaded from the service you used to login, the CodiMD instance or Libravatar.|
|Uploaded pictures| Pictures that are uploaded for documents are either uploaded to Amazon S3, Imgur, a minio instance or the local filesystem of the CodiMD server.|
| your data | our usage |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| IP-Address | Used to communicate with your browser and our servers. It's may exposed to third-parties which provide resources for this service. These services are, depending on your login method, the document you visit and the setup of this instance: Google, Disqus, MathJax, GitHub, SlideShare/LinkedIn, yahoo, Libravatar, Imgur, Amazon, and Cloudflare. |
| Usernames and profiles | Your username as well as user profiles that are connected with it are transmitted and stored by us to provide a useful login integration with services like GitHub, Facebook, Twitter, GitLab, Dropbox, Google. Depending on the setup of this CodiMD instance there are maybe other third-parties involved using SAML, LDAP or the integration with a Mattermost instance. |
| Profile pictures | Your profile picture is either loaded from the service you used to login, the CodiMD instance or Libravatar. |
| Uploaded pictures | Pictures that are uploaded for documents are either uploaded to Amazon S3, Imgur, a minio instance or the local filesystem of the CodiMD server. |
All account data and notes are stored in a mysql/postgres/sqlite database. Besides the user accounts and the document themselves also relationships between the documents and the user accounts are stored. This includes ownership, authorship and revisions of all changes made during the creation of a note.

1975
public/docs/release-notes.md
View file

File diff suppressed because it is too large Load diff

6
public/docs/slide-example.md
View file

@ -9,7 +9,7 @@ slideOptions:
This feature still in beta, may have some issues.
For details please visit:
https://github.com/hakimel/reveal.js/
<https://github.com/hakimel/reveal.js/>
You can use `URL query` or `slideOptions` of the YAML metadata to customize your slides.
@ -29,7 +29,7 @@ Is the divider of slides
Is the divider of branches
Use the _Space_ key to navigate through all slides.
Use the *Space* key to navigate through all slides.
----
@ -254,7 +254,7 @@ You can link between slides internally, [like this](#/1/3).
There's a [speaker view](https://github.com/hakimel/reveal.js#speaker-notes). It includes a timer, preview of the upcoming slide as well as your speaker notes.
Press the _S_ key to try it out.
Press the *S* key to try it out.
Note:
Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit `s` on your keyboard).

61
public/docs/yaml-metadata.md
View file

@ -5,11 +5,10 @@ dir: ltr
breaks: true
---
Supported YAML metadata
===
# Supported YAML metadata
First you need to insert syntax like this at the **start** of the note:
```
```yaml
---
YAML metas
---
@ -18,8 +17,8 @@ YAML metas
Replace the "YAML metas" in this section with any YAML options as below.
You can also refer to this note's source code.
title
---
## title
This option will set the note title which prior than content title.
> default: not set
@ -29,8 +28,8 @@ This option will set the note title which prior than content title.
title: meta title
```
description
---
## description
This option will set the note description as a `<meta name="description">` tag. This only affects the [Publish](../features#Share-Notes) function.
> default: not set
@ -40,8 +39,8 @@ This option will set the note description as a `<meta name="description">` tag.
description: meta description
```
tags
---
## tags
This option will set the tags which prior than content tags.
> default: not set
@ -51,8 +50,8 @@ This option will set the tags which prior than content tags.
tags: features, cool, updated
```
robots
---
## robots
This option will give below meta in the note head meta:
```xml
<meta name="robots" content="your_meta">
@ -66,12 +65,12 @@ So you can prevent any search engine index your note by set `noindex, nofollow`.
robots: noindex, nofollow
```
lang
---
## lang
This option will set the language of the note.
Setting the language helps the browser to apply rules such as typography correctly.
You can find your the language code in ISO 639-1 standard:
https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
<https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>
> default: not set (which will be en)
@ -80,12 +79,12 @@ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
langs: ja-jp
```
dir
---
## dir
This option specifies the direction of the text in this note.
You can only use whether `rtl` or `ltr`.
Look more at here:
http://www.w3.org/International/questions/qa-html-dir
<http://www.w3.org/International/questions/qa-html-dir>
> default: not set (which will be ltr)
@ -94,8 +93,8 @@ http://www.w3.org/International/questions/qa-html-dir
dir: rtl
```
breaks
---
## breaks
This option means the hardbreaks in the note will be parsed or be ignore.
The original markdown syntax breaks only if you put space twice, but CodiMD choose to breaks every time you enter a break.
You can only use whether `true` or `false`.
@ -107,8 +106,8 @@ You can only use whether `true` or `false`.
breaks: false
```
GA
---
## GA
This option allows you to enable Google Analytics with your ID.
> default: not set (which won't enable)
@ -118,8 +117,8 @@ This option allows you to enable Google Analytics with your ID.
GA: UA-12345667-8
```
disqus
---
## disqus
This option allows you to enable Disqus with your shortname.
> default: not set (which won't enable)
@ -129,8 +128,8 @@ This option allows you to enable Disqus with your shortname.
disqus: codimd
```
type
---
## type
This option allows you to switch the document view to the slide preview, to simplify live editing of presentations.
> default: not set
@ -140,14 +139,14 @@ This option allows you to switch the document view to the slide preview, to simp
type: slide
```
slideOptions
---
## slideOptions
This option allows you to provide custom options to slide mode.
Please below document for more details:
https://github.com/hakimel/reveal.js/#configuration
<https://github.com/hakimel/reveal.js/#configuration>
You could also set slide theme which named in below css files:
https://github.com/hakimel/reveal.js/tree/master/css/theme
<https://github.com/hakimel/reveal.js/tree/master/css/theme>
**Notice: always use two spaces as indention in YAML metadata!**
@ -160,8 +159,8 @@ slideOptions:
theme: white
```
opengraph
---
## opengraph
This option allows you to override the default generated opengraph metadata.
See the [OpenGraph protocol documentation](https://ogp.me) for more information.