LailaTheElf/hedgedoc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Replace Unicode character with emoji shortcode

Browse Source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2021-04-03 21:14:53 +02:00
parent c093c67c67
commit 4a0b00d0a6
No known key found for this signature in database
GPG Key ID: B97799103358209B
1 changed files with 50 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
docs/content/references/hfm.md
View File

@ -12,34 +12,34 @@ These tables will tell you what exactly we support in HedgeDoc 1.x (HFM 1) and w
| Feature | HFM 1 | HFM 2 | CommonMark | GFM | | Feature | HFM 1 | HFM 2 | CommonMark | GFM |
|---------------|:-----:|:-----:|:-------------------:|:-----------------:| |---------------|:-----:|:-----:|:-------------------:|:-----------------:|
| bold | ☑️ | ☑️ | ☑️ | ☑️ | | bold | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| italic | ☑️ | ☑️ | ☑️ | ☑️ | | italic | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| underline | ☑️ | ☑️ | (☑️ with `<ins>`) | (☑️ with `<ins>`) | | underline | :ballot_box_with_check: | :ballot_box_with_check: | (:ballot_box_with_check: with `<ins>`) | (:ballot_box_with_check: with `<ins>`) |
| strikethrough | ☑️ | ☑️ | (☑️ with `<del>`) | ☑️ | | strikethrough | :ballot_box_with_check: | :ballot_box_with_check: | (:ballot_box_with_check: with `<del>`) | :ballot_box_with_check: |
| subscript | ☑️ | ☑️ | (☑️ with `<sub>`) | (☑️ with `<sub>`) | | subscript | :ballot_box_with_check: | :ballot_box_with_check: | (:ballot_box_with_check: with `<sub>`) | (:ballot_box_with_check: with `<sub>`) |
| superscript | ☑️ | ☑️ | (☑️ with `<sup>`) | (☑️ with `<sup>`) | | superscript | :ballot_box_with_check: | :ballot_box_with_check: | (:ballot_box_with_check: with `<sup>`) | (:ballot_box_with_check: with `<sup>`) |
| marked | ☑️ | ☑️ | (☑️ with `<mark>`) | (☑️ with `<mark>`) | | marked | :ballot_box_with_check: | :ballot_box_with_check: | (:ballot_box_with_check: with `<mark>`) | (:ballot_box_with_check: with `<mark>`) |
## Extended typography features ## Extended typography features
| Feature | HFM 1 | HFM 2 | CommonMark | GFM | | Feature | HFM 1 | HFM 2 | CommonMark | GFM |
|--------------------------------|:-----:|:-----:|:----------:|:---:| |--------------------------------|:-----:|:-----:|:----------:|:---:|
| heading | ☑️ | ☑️ | ☑️ | ☑️ | | heading | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| inline code | ☑️ | ☑️ | ☑️ | ☑️ | | inline code | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| indented code blocks | ☑️ | ☑️ | ☑️ | ☑️ | | indented code blocks | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| code block with language[^highlight] | ☑️ | ☑️ | ☑️ | ☑️ | | code block with language[^highlight] | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| code block with extra features[^extra-code] | ☑️ | ☑️ | | | | code block with extra features[^extra-code] | :ballot_box_with_check: | :ballot_box_with_check: | | |
| block quote | ☑️ | ☑️ | ☑️ | ☑️ | | block quote | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| name tag (`[name=...]`) | (☑️)[^in-bq-list] | ☑️ | | | | name tag (`[name=...]`) | (:ballot_box_with_check:)[^in-bq-list] | :ballot_box_with_check: | | |
| time tag (`[time=...]`) | (☑️)[^in-bq-list] | ☑️ | | | | time tag (`[time=...]`) | (:ballot_box_with_check:)[^in-bq-list] | :ballot_box_with_check: | | |
| color tag (`[color=...]`) | (☑️)[^in-bq-list] | ☑️ | | | | color tag (`[color=...]`) | (:ballot_box_with_check:)[^in-bq-list] | :ballot_box_with_check: | | |
| unorderd list | ☑️ | ☑️ | ☑️ | ☑️ | | unorderd list | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| ordered list | ☑️ | ☑️ | ☑️ | ☑️ | | ordered list | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| task list | ☑️ | ☑️ | | ☑️ | | task list | :ballot_box_with_check: | :ballot_box_with_check: | | :ballot_box_with_check: |
| defition list | ☑️ | ☑️ | | | | defition list | :ballot_box_with_check: | :ballot_box_with_check: | | |
| emoji | [Unicode 6.1][unicode-6] | [Unicode 13][unicode-13] | | | | emoji | [Unicode 6.1][unicode-6] | [Unicode 13][unicode-13] | | |
| [ForkAwesome][fa] | ☑️ with `<i class='fa'>` | ☑️ with shortcodes | | | | [ForkAwesome][fa] | :ballot_box_with_check: with `<i class='fa'>` | :ballot_box_with_check: with shortcodes | | |
| LaTeX | ☑️[^mj] | ☑️[^kt] | | | | LaTeX | :ballot_box_with_check:[^mj] | :ballot_box_with_check:[^kt] | | |
[^highlight]: Code-blocks with a given language are rendered with syntax-highlighting for the code. [^highlight]: Code-blocks with a given language are rendered with syntax-highlighting for the code.
[^extra-code]: Several special "language" keywords can be used for rendering diagrams, charts, etc. [^extra-code]: Several special "language" keywords can be used for rendering diagrams, charts, etc.
@ -51,25 +51,25 @@ These tables will tell you what exactly we support in HedgeDoc 1.x (HFM 1) and w
| Feature | HFM 1 | HFM 2 | CommonMark | GFM | | Feature | HFM 1 | HFM 2 | CommonMark | GFM |
|-----------------------|:-----:|:-----:|:----------------:|:----------------:| |-----------------------|:-----:|:-----:|:----------------:|:----------------:|
| link | ☑️ | ☑️ | ☑️ | ☑️ | | link | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| link reference | ☑️ | ☑️ | ☑️ | ☑️ | | link reference | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| link title | ☑️ | ☑️ | ☑️ | ☑️ | | link title | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| autolink with `<>` | ☑️ | ☑️ | ☑️ | ☑️ | | autolink with `<>` | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| autolink without `<>` | ☑️ | ☑️ | | ☑️ | | autolink without `<>` | :ballot_box_with_check: | :ballot_box_with_check: | | :ballot_box_with_check: |
| footnotes | ☑️ | ☑️ | | | | footnotes | :ballot_box_with_check: | :ballot_box_with_check: | | |
| image | ☑️ | ☑️ | ☑️ | ☑️ | | image | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| image with given size | ☑️ | ☑️ | (☑️ with `<img>`) | (☑️ with `<img>`) | | image with given size | :ballot_box_with_check: | :ballot_box_with_check: | (:ballot_box_with_check: with `<img>`) | (:ballot_box_with_check: with `<img>`) |
| table of contents | ☑️ | ☑️ | | | | table of contents | :ballot_box_with_check: | :ballot_box_with_check: | | |
## Structural elements ## Structural elements
| Feature | HFM 1 | HFM 2 | CommonMark | GFM | | Feature | HFM 1 | HFM 2 | CommonMark | GFM |
|-------------------|:------------------------:|:------------------------:|:--------------------:|:--------------------:| |-------------------|:------------------------:|:------------------------:|:--------------------:|:--------------------:|
| table | ☑️ | ☑️ | (☑️ with `<table>`) | ☑️ | | table | :ballot_box_with_check: | :ballot_box_with_check: | (:ballot_box_with_check: with `<table>`) | :ballot_box_with_check: |
| horizontal line | ☑️ | ☑️ | ☑️ | ☑️ | | horizontal line | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: |
| collapsable block | (☑️ with `<details>`) | ☑️ | (☑️ with `<details>`) | (☑️ with `<details>`) | | collapsable block | (:ballot_box_with_check: with `<details>`) | :ballot_box_with_check: | (:ballot_box_with_check: with `<details>`) | (:ballot_box_with_check: with `<details>`) |
| Alerts | ☑️ | ☑️ | | | | Alerts | :ballot_box_with_check: | :ballot_box_with_check: | | |
## Embeddings ## Embeddings
HFM1 included support for certain embeddings of external content. These were defined in markdown by the uncommon `{%keyword parameter %}` syntax. HFM1 included support for certain embeddings of external content. These were defined in markdown by the uncommon `{%keyword parameter %}` syntax.
@ -78,12 +78,12 @@ Instead of this uncommon syntax, HFM2 uses just plain links to external content
| Feature | HFM 1 | HFM 2 | CommonMark | GFM | | Feature | HFM 1 | HFM 2 | CommonMark | GFM |
|--------------------------|:-----:|:------------------:|:----------:|:---:| |--------------------------|:-----:|:------------------:|:----------:|:---:|
| PDF (`{%pdf ... %}`) | ☑️ | removed | | | | PDF (`{%pdf ... %}`) | :ballot_box_with_check: | removed | | |
| [YouTube][youtube] (`{%youtube ... %}`) | ☑️ | with plain link[^embed] | | | | [YouTube][youtube] (`{%youtube ... %}`) | :ballot_box_with_check: | with plain link[^embed] | | |
| [Vimeo][vimeo] (`{%vimeo ... %}`) | ☑️ | with plain link[^embed] | | | | [Vimeo][vimeo] (`{%vimeo ... %}`) | :ballot_box_with_check: | with plain link[^embed] | | |
| [Slideshare][slideshare] (`{%slideshare ... %}`) | ☑️ | removed | | | | [Slideshare][slideshare] (`{%slideshare ... %}`) | :ballot_box_with_check: | removed | | |
| [Speakerdeck][speakerdeck] (`{%speakerdeck ... %}`) | ☑️ | removed | | | | [Speakerdeck][speakerdeck] (`{%speakerdeck ... %}`) | :ballot_box_with_check: | removed | | |
| [GitHub Gist][gist] (`{%gist ... %}`) | ☑️ | with plain link[^embed] | | | | [GitHub Gist][gist] (`{%gist ... %}`) | :ballot_box_with_check: | with plain link[^embed] | | |
[^embed]: The special syntax is deprecated but will continue to work. However a plain link to the content will generate the same embedding and is preferred. [^embed]: The special syntax is deprecated but will continue to work. However a plain link to the content will generate the same embedding and is preferred.
@ -92,15 +92,15 @@ Besides the basic HTML typography elements (`<p>`, `<a>`, `<b>`, `<ins>`, `<del>
| Feature | HedgeDocMark 1 | HedgeDocMark 2 | CommonMark | GFM | | Feature | HedgeDocMark 1 | HedgeDocMark 2 | CommonMark | GFM |
|:-------------:|:--------------:|:--------------:|:----------:|:---:| |:-------------:|:--------------:|:--------------:|:----------:|:---:|
| `<title>` | | | ☑️ | | | `<title>` | | | :ballot_box_with_check: | |
| `<textarea>` | | ☑️ | ☑️ | | | `<textarea>` | | :ballot_box_with_check: | :ballot_box_with_check: | |
| `<style>` | ☑️ | ☑️ | ☑️ | | | `<style>` | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | |
| `<xmp>` | | | ☑️ | | | `<xmp>` | | | :ballot_box_with_check: | |
| `<iframe>` | ☑️ | ☑️ | ☑️ | | | `<iframe>` | :ballot_box_with_check: | :ballot_box_with_check: | :ballot_box_with_check: | |
| `<noembed>` | ☑️ | | ☑️ | | | `<noembed>` | :ballot_box_with_check: | | :ballot_box_with_check: | |
| `<noframes>` | ☑️ | | ☑️ | | | `<noframes>` | :ballot_box_with_check: | | :ballot_box_with_check: | |
| `<script>` | | | ☑️ | | | `<script>` | | | :ballot_box_with_check: | |
| `<plaintext>` | | ☑️ | ☑️ | | | `<plaintext>` | | :ballot_box_with_check: | :ballot_box_with_check: | |
[fa]: https://forkaweso.me/ [fa]: https://forkaweso.me/
[youtube]: https://www.youtube.com/ [youtube]: https://www.youtube.com/