diff --git a/docs/content/references/hfm.md b/docs/content/references/hfm.md index c72746606..379fe0ef8 100644 --- a/docs/content/references/hfm.md +++ b/docs/content/references/hfm.md @@ -8,36 +8,36 @@ These tables tell you what exactly we support in HedgeDoc 1.x (HFM 1) and HedgeD ## Typography -| Feature | HFM 1 | HFM 2 | CommonMark | GFM | -|---------------|:-----:|:-----:|:-------------------:|:-----------------:| -| bold | ☑️ | ☑️ | ☑️ | ☑️ | -| italic | ☑️ | ☑️ | ☑️ | ☑️ | -| underline | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | -| strikethrough | ☑️ | ☑️ | (☑️ with ``) | ☑️ | -| subscript | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | -| superscript | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | -| marked | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | +| Feature | HFM 1 | HFM 2 | CommonMark | GFM | +| ------------- | :---: | :---: | :---------------: | :---------------: | +| bold | ☑️ | ☑️ | ☑️ | ☑️ | +| italic | ☑️ | ☑️ | ☑️ | ☑️ | +| underline | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | +| strikethrough | ☑️ | ☑️ | (☑️ with ``) | ☑️ | +| subscript | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | +| superscript | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | +| marked | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | ## Extended typography features -| Feature | HFM 1 | HFM 2 | CommonMark | GFM | -|--------------------------------|:-----:|:-----:|:----------:|:---:| -| heading | ☑️ | ☑️ | ☑️ | ☑️ | -| inline code | ☑️ | ☑️ | ☑️ | ☑️ | -| indented code blocks | ☑️ | ☑️ | ☑️ | ☑️ | -| code block with language[^highlight] | ☑️ | ☑️ | ☑️ | ☑️ | -| code block with extra features[^extra-code] | ☑️ | ☑️ | | | -| block quote | ☑️ | ☑️ | ☑️ | ☑️ | -| name tag (`[name=...]`) | (☑️)[^in-bq-list] | ☑️ | | | -| time tag (`[time=...]`) | (☑️)[^in-bq-list] | ☑️ | | | -| color tag (`[color=...]`) | (☑️)[^in-bq-list] | ☑️ | | | -| unorderd list | ☑️ | ☑️ | ☑️ | ☑️ | -| ordered list | ☑️ | ☑️ | ☑️ | ☑️ | -| task list | ☑️ | ☑️ | | ☑️ | -| defition list | ☑️ | ☑️ | | | -| emoji | [Unicode 6.1][unicode-6] | [Unicode 13][unicode-13] | | | -| [ForkAwesome][fa] | ☑️ with `` | ☑️ with shortcodes | | | -| LaTeX | ☑️[^mj] | ☑️[^kt] | | | +| Feature | HFM 1 | HFM 2 | CommonMark | GFM | +| ------------------------------------------- | :----------------------: | :----------------------: | :--------: | :---: | +| heading | ☑️ | ☑️ | ☑️ | ☑️ | +| inline code | ☑️ | ☑️ | ☑️ | ☑️ | +| indented code blocks | ☑️ | ☑️ | ☑️ | ☑️ | +| code block with language[^highlight] | ☑️ | ☑️ | ☑️ | ☑️ | +| code block with extra features[^extra-code] | ☑️ | ☑️ | | | +| block quote | ☑️ | ☑️ | ☑️ | ☑️ | +| name tag (`[name=...]`) | (☑️)[^in-bq-list] | ☑️ | | | +| time tag (`[time=...]`) | (☑️)[^in-bq-list] | ☑️ | | | +| color tag (`[color=...]`) | (☑️)[^in-bq-list] | ☑️ | | | +| unorderd list | ☑️ | ☑️ | ☑️ | ☑️ | +| ordered list | ☑️ | ☑️ | ☑️ | ☑️ | +| task list | ☑️ | ☑️ | | ☑️ | +| defition list | ☑️ | ☑️ | | | +| emoji | [Unicode 6.1][unicode-6] | [Unicode 13][unicode-13] | | | +| [ForkAwesome][fa] | ☑️ with `` | ☑️ with shortcodes | | | +| LaTeX | ☑️[^mj] | ☑️[^kt] | | | [^highlight]: Code blocks with a given language are rendered using syntax highlighting. [^extra-code]: Several special "language" keywords can be used for rendering diagrams, charts, etc. @@ -47,56 +47,56 @@ These tables tell you what exactly we support in HedgeDoc 1.x (HFM 1) and HedgeD ## Links & Images -| Feature | HFM 1 | HFM 2 | CommonMark | GFM | -|-----------------------|:-----:|:-----:|:----------------:|:----------------:| -| link | ☑️ | ☑️ | ☑️ | ☑️ | -| link reference | ☑️ | ☑️ | ☑️ | ☑️ | -| link title | ☑️ | ☑️ | ☑️ | ☑️ | -| autolink with `<>` | ☑️ | ☑️ | ☑️ | ☑️ | -| autolink without `<>` | ☑️ | ☑️ | | ☑️ | -| footnotes | ☑️ | ☑️ | | | -| image | ☑️ | ☑️ | ☑️ | ☑️ | -| image with given size | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | -| table of contents | ☑️ | ☑️ | | | +| Feature | HFM 1 | HFM 2 | CommonMark | GFM | +| --------------------- | :---: | :---: | :--------------: | :--------------: | +| link | ☑️ | ☑️ | ☑️ | ☑️ | +| link reference | ☑️ | ☑️ | ☑️ | ☑️ | +| link title | ☑️ | ☑️ | ☑️ | ☑️ | +| autolink with `<>` | ☑️ | ☑️ | ☑️ | ☑️ | +| autolink without `<>` | ☑️ | ☑️ | | ☑️ | +| footnotes | ☑️ | ☑️ | | | +| image | ☑️ | ☑️ | ☑️ | ☑️ | +| image with given size | ☑️ | ☑️ | (☑️ with ``) | (☑️ with ``) | +| table of contents | ☑️ | ☑️ | | | ## Structural elements -| Feature | HFM 1 | HFM 2 | CommonMark | GFM | -|-------------------|:------------------------:|:------------------------:|:--------------------:|:--------------------:| -| table | ☑️ | ☑️ | (☑️ with ``) | ☑️ | -| horizontal line | ☑️ | ☑️ | ☑️ | ☑️ | -| collapsable block | (☑️ with `
`) | ☑️ | (☑️ with `
`) | (☑️ with `
`) | -| Alerts | ☑️ | ☑️ | | | +| Feature | HFM 1 | HFM 2 | CommonMark | GFM | +| ----------------- | :------------------: | :---: | :------------------: | :------------------: | +| table | ☑️ | ☑️ | (☑️ with `
`) | ☑️ | +| horizontal line | ☑️ | ☑️ | ☑️ | ☑️ | +| collapsable block | (☑️ with `
`) | ☑️ | (☑️ with `
`) | (☑️ with `
`) | +| Alerts | ☑️ | ☑️ | | | ## Embeddings HFM 1 includes support for certain embeddings of external content by using the `{%keyword parameter %}` syntax. To increase the readability of the markdown code we decided that HFM 2 should just use plain links if possible. -| Feature | HFM 1 | HFM 2 | CommonMark | GFM | -|--------------------------|:-----:|:------------------:|:----------:|:---:| -| PDF (`{%pdf ... %}`) | ☑️ | removed | | | -| [YouTube][youtube] (`{%youtube ... %}`) | ☑️ | with plain link[^embed] | | | -| [Vimeo][vimeo] (`{%vimeo ... %}`) | ☑️ | with plain link[^embed] | | | -| [Slideshare][slideshare] (`{%slideshare ... %}`) | ☑️ | removed | | | -| [Speakerdeck][speakerdeck] (`{%speakerdeck ... %}`) | ☑️ | removed | | | -| [GitHub Gist][gist] (`{%gist ... %}`) | ☑️ | with plain link[^embed] | | | +| Feature | HFM 1 | HFM 2 | CommonMark | GFM | +| --------------------------------------------------- | :---: | :---------------------: | :--------: | :---: | +| PDF (`{%pdf ... %}`) | ☑️ | removed | | | +| [YouTube][youtube] (`{%youtube ... %}`) | ☑️ | with plain link[^embed] | | | +| [Vimeo][vimeo] (`{%vimeo ... %}`) | ☑️ | with plain link[^embed] | | | +| [Slideshare][slideshare] (`{%slideshare ... %}`) | ☑️ | removed | | | +| [Speakerdeck][speakerdeck] (`{%speakerdeck ... %}`) | ☑️ | removed | | | +| [GitHub Gist][gist] (`{%gist ... %}`) | ☑️ | with plain link[^embed] | | | [^embed]: The special syntax from HFM 1 is deprecated, but will still work in HFM 2. However, a plain link to the content should be used. ## HTML Besides the basic HTML typography elements (`

`, ``, ``, ``, ``) the following more special HTML elements are supported by some specification. -| Feature | HedgeDocMark 1 | HedgeDocMark 2 | CommonMark | GFM | -|:-------------:|:--------------:|:--------------:|:----------:|:---:| -| `` | | | ☑️ | | -| `<textarea>` | | ☑️ | ☑️ | | -| `<style>` | ☑️ | ☑️ | ☑️ | | -| `<xmp>` | | | ☑️ | | -| `<iframe>` | ☑️ | ☑️ | ☑️ | | -| `<noembed>` | ☑️ | | ☑️ | | -| `<noframes>` | ☑️ | | ☑️ | | -| `<script>` | | | ☑️ | | -| `<plaintext>` | | ☑️ | ☑️ | | +| Feature | HedgeDocMark 1 | HedgeDocMark 2 | CommonMark | GFM | +| :-----------: | :------------: | :------------: | :--------: | :---: | +| `<title>` | | | ☑️ | | +| `<textarea>` | | ☑️ | ☑️ | | +| `<style>` | ☑️ | ☑️ | ☑️ | | +| `<xmp>` | | | ☑️ | | +| `<iframe>` | ☑️ | ☑️ | ☑️ | | +| `<noembed>` | ☑️ | | ☑️ | | +| `<noframes>` | ☑️ | | ☑️ | | +| `<script>` | | | ☑️ | | +| `<plaintext>` | | ☑️ | ☑️ | | [fa]: https://forkaweso.me/ [youtube]: https://www.youtube.com/