github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 11:16:31 -05:00
Code Issues Projects Releases Packages Wiki Activity
hedgedoc/docs/content/faq/index.md
Philip Molares e07cd62596 docs: restructure documentation 
This rewrite follows the principles of https://diataxis.fr/

Co-authored-by: Erik Michelson <github@erik.michelson.eu>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-09-17 21:50:21 +02:00

3.1 KiB
Raw Blame History

Frequently Asked Questions

This page collects Frequently Asked Questions of the community.
If you have any questions that aren't answered here, feel free to ask on our community forums or in out Matrix chat.

Why did you switch from MathJax to KaTeX?

The new react frontend, that was introduced with HedgeDoc 2.0 switched from MathJax 2 to KaTeX, because:

Why are code-blocks with 'sequence' as language deprecated?

Starting with HedgeDoc 2.0, mermaid is used for rendering sequence-diagrams. The syntax doesn't change. To remove the deprecation warning, simply change the codeblock-"language" from sequence to mermaid and insert a single line with sequenceDiagram just before your diagram content.

Deprecated:

Alice->>John: Hello John, how are you?
John-->>Alice: Great!

New:

sequenceDiagram
Alice->>John: Hello John, how are you?
John-->>Alice: Great!

Why do tags in headings don't work anymore?

Starting with HedgeDoc 2.0, we don't support tag headings in the note anymore.

#### tags: `tag1`, `tag2`

Instead, please use the frontmatter metadata to specify tags.

Why is the comma separated definition of tags in the YAML-metadata deprecated?

YAML already has a definition for lists. Therefore, we don't see any reason to maintain another way to define a list.

Deprecated

tags: tag1, tag2

New

tags:
    - tag1
    - tag2

or

tags: ['tag1', 'tag2']

Why should I want to run my renderer on a different (sub-)domain?

If the renderer is provided by another domain, it's way harder to manipulate HedgeDoc or steal credentials from the rendered note content, because renderer and editor are more isolated. This increases the security of the software and greatly mitigates XSS attacks. However, you can run HedgeDoc without this extra security, but we recommend using it if possible.

!!! note When you want to use a separate domain for HD_RENDERER_BASE_URL, your reverse proxy config needs to be adjusted to direct requests for this domain to the frontend.