| tags |
|---|
features, cool, updated |
HedgeDoc 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.
If you experience any issues, feel free to report it on GitHub. Or meet us on Matrix for dev-talk and interactive help. Thank you very much!
When you are tired of a white screen and like a night mode, click on the little moon and turn on the night view of HedgeDoc.
The editor view, which is in night mode by default, can also be toggled between night and day view using the the little sun.
You can upload an image simply by clicking on the upload button . Alternatively, you can drag-n-drop an image into the editor. Even pasting images is possible! This will automatically upload the image to imgur, Amazon S3, Minio or the local filesystem (depending on the instance's configuration), nothing to worry about. 🎉
If you want to share an editable note, just copy the URL. If you want to share a read-only note, simply press the publish button and copy the URL.
Currently, you can save to Dropbox (depending on the instance's configuration) or save a Markdown , HTML or raw HTML file locally.
Similarly to the save feature, you can also import a Markdown file from Dropbox (depending on the instance's configuration), or import content from your clipboard , which can parse some HTML. 😃
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 | |
|---|---|---|---|---|---|
| Freely | ✔ | ✔ | ✔ | ✔ | ✔ |
| Editable | ✔ | ✔ | ✔ | ✔ | ✖ |
| Limited | ✔ | ✔ | ✔ | ✖ | ✖ |
| Locked | ✔ | ✔ | ✖ | ✔ | ✖ |
| Protected | ✔ | ✔ | ✖ | ✖ | ✖ |
| Private | ✔ | ✖ | ✖ | ✖ | ✖ |
| Owner read/write | Signed-in read | Signed-in write | Guest read | Guest write | |
|---|---|---|---|---|---|
| :fa-leaf-fw: Freely | ✔ | ✔ | ✔ | ✔ | ✔ |
| :fa-leaf-fw: Freely | ✔ | ✔ | ✔ | ✔ | ✔ |
| :fa-pencil-fw: Editable | ✔ | ✔ | ✔ | ✔ | ✖ |
| :fa-id-card-fw: Limited | ✔ | ✔ | ✔ | ✖ | ✖ |
| :fa-lock-fw: Locked | ✔ | ✔ | ✖ | ✔ | ✖ |
| :fa-umbrella-fw: Protected | ✔ | ✔ | ✖ | ✖ | ✖ |
| :fa-hand-fw: Private | ✔ | ✖ | ✖ | ✖ | ✖ |
Only the owner of the note can change the note's permissions.
[Net ATP yields per hexose]
| Stage | Direct Products | ATP Yields |
|---|---|---|
| Glycolysis | 2 ATP | |
| ^^ | 2 NADH | 3--5 ATP |
| Pyruvaye oxidation | 2 NADH | 5 ATP |
| Citric acid cycle | 2 ATP | |
| ^^ | 6 NADH | 15 ATP |
| ^^ | 2 FADH2 | 3 ATP |
| 30--32 ATP |
|--|--|--|--|--|--|--|--| |♜| |♝|♛|♚|♝|♞|♜| | |♟|♟|♟| |♟|♟|♟| |♟| |♞| | | | | | | |♗| | |♟| | | | | | | | |♙| | | | | | | | | |♘| | | |♙|♙|♙|♙| |♙|♙|♙| |♖|♘|♗|♕|♔| | |♖|
You can use a special syntax to organize your note into slides. After that, you can use the Slide Mode to make a presentation. Visit the above link for details.
To switch the editor into slide mode, set the document type to slide.
You can look at the bottom right section of the view area, there is a ToC button . 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.
Every header will automatically add a permalink on the right side. You can hover and click to anchor on it.
You can look in the bottom right section of the editor area, there you'll find a button with SUBLIME on it.
When you click it, you can select 3 editor modes, which will also define your shortcut keys:
This editor provides full auto-complete hints in markdown.
- Emojis: type
:to show hints. - Code blocks: type
```, followed by another character to show syntax highlighting suggestions. - Headers: type
#to show hint. - Referrals: type
[]to show hint. - Externals: type
{}to show hint. - Images: type
!to show hint.
The first level 1 heading (e.g. # Title) will be used as the note title.
Tags can be specified with YAML metadata at the start of the note. Those tags will show in your history.
---
tags: features, cool, updated
---A QR code can be rendered using:
```qr
Just something that should turn into a QR!
```
Which renders to:
Just something that should turn into a QR!
You can also specify a custom width and height (using qr=500x500 for example). This will screw up your page rendering if it's viewed on a smaller size though.
Best to let the QR be rendered without sizes specified which makes it auto resizable.
You can provide advanced note information to set the browser behavior (visit above link for details):
- robots: set web robots meta
- lang: set browser language
- dir: set text direction
- breaks: set to use line breaks
- GA: set to use Google Analytics
- disqus: set to use Disqus
- slideOptions: setup slide mode options
Use the syntax [TOC] to embed a table of contents into your note.
[TOC]
This extension adds support for progress bars in Markdown. The width of the progress bar is calculated with two decimal precision and truncated, not rounded. Templates can include decimal precision notation. You can find the full spec here.
The syntax for the progress bar is:
[progress current [start] [end] ["template"]]
current: Required integer or float representing the current value of the progress bar. This value must be between the start (0 as default) and end (100 as default) values.start(optional): Optional integer or float representing the starting value of the progress bar. Defaults to 0 if not provided.end(optional): Optional integer or float representing the ending value of the progress bar. Defaults to 100 if not provided.template: Optional string that defines the text to be displayed on the progress bar. Placeholders{1},{2},{3}, and{%}can be used to represent the current value, start value, end value, and the current percentage respectively. Placeholder precision can be specified using a colon followed by the number of decimal places up to 9 max.
This example shows how to use a template to display the current value with two decimal places. [progress 75 "Current: {1:.2}"]
[progress 75 "Current: {1:.2}"]This example demonstrates how to use start and end values. [progress 30 0 100]
[progress 30 0 100]This example shows how the progress bar handles high precision values. [progress 32.54876 "Current: {1:.9}"]
[progress 32.54876 "Current: {1:.9}"]You can type any emoji like this 😄 😃 😢 😉
See full emoji list here.
- ToDos
- Buy some salad
- Brush teeth
- Drink some water
- Click my box and see the source code, if you're allowed to edit!
We support many programming languages, use the auto complete function to see the entire list.
var s = "JavaScript syntax highlighting";
alert(s);
function $initHighlight(block, cls) {
try {
if (cls.search(/\bno\-highlight\b/) != -1)
return process(block, true, 0x0F) +
' class=""';
} catch (e) {
/* handle exception */
}
for (var i = 0 / 2; i < classes.length; i++) {
if (checkCondition(classes[i]) === undefined)
return /\d+[\s/]/g;
}
}
If you want line numbers, type = after specifying the code block languagues.
Also, you can specify the start line number.
Like below, the line number starts from 101:
var s = "JavaScript syntax highlighting";
alert(s);
function $initHighlight(block, cls) {
try {
if (cls.search(/\bno\-highlight\b/) != -1)
return process(block, true, 0x0F) +
' class=""';
} catch (e) {
/* handle exception */
}
for (var i = 0 / 2; i < classes.length; i++) {
if (checkCondition(classes[i]) === undefined)
return /\d+[\s/]/g;
}
}
Or you might want to continue the previous code block's line number, use =+:
var s = "JavaScript syntax highlighting";
alert(s);
Somtimes you have a super long text without breaks. It's time to use ! to wrap your code:
When you’re a carpenter making a beautiful chest of drawers, you’re not going to use a piece of plywood on the back.
Using the syntax below to specifiy your name, time and color to vary the blockquotes. [name=ChengHan Wu] [time=Sun, Jun 28, 2015 9:59 PM] [color=#907bf7]
Even support nested blockquotes! [name=Max Mustermann] [time=Sun, Jun 28, 2015 9:47 PM] [color=red]
You can use write csv in the codeblock:
```csvpreview {header="true"}
firstName,lastName,email,phoneNumber
John,Doe,john@doe.com,0123456789
Jane,Doe,jane@doe.com,9876543210
James,Bond,james.bond@mi6.co.uk,0612345678
```which renderes as:
firstName,lastName,email,phoneNumber
John,Doe,john@doe.com,0123456789
Jane,Doe,jane@doe.com,9876543210
James,Bond,james.bond@mi6.co.uk,0612345678
We use Papa Parse for parsing csv. The parsing option is given in braces: {}, and multiple options are seperated by a space. e.g. {header="true" delimiter="."}. Please read their documentation as reference.
{%youtube aqz-KE-bpKQ %}
{%vimeo 124148255 %}
{%gist schacon/4277%}
{%slideshare briansolis/26-disruptive-technology-trends-2016-2018-56796196 %}
Caution: this might be blocked by your browser if not using an https URL.
Note that not all servers allow embedding their content. See our FAQ for details.
{%pdf https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf %}
You can render LaTeX mathematical expressions using MathJax, as on math.stackexchange.com. Examples:
- The Euler's identity:
$e^{i\pi} + 1 = 0$ - The solution of
$f(x)=ax^2+bx+c$ where$a \neq 0$ and$a, b, c \in R$ is $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$ - The Gamma function: $\Gamma(n) = \begin{cases} \displaystyle (n-1)!\quad\forall n\in\mathbb N\ \displaystyle \int_0^\infty t^{n-1}e^{-t}dt\quad\forall n\in\mathbb R^*_+ \end{cases}$
More information about LaTeX mathematical expressions here.
You can render sequence diagrams like this:
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
Note left of Alice: Alice responds
Alice->Bob: Where have you been?
More information about sequence diagrams syntax here.
Flow charts can be specified like this:
st=>start: Start
e=>end: End
op=>operation: My Operation
op2=>operation: lalala
cond=>condition: Yes or No?
st->op->op2->cond
cond(yes)->e
cond(no)->op2
More information about flow charts syntax here.
digraph hierarchy {
nodesep=1.0 // Increases the separation between nodes
node [color=Red,fontname=Courier,shape=box] // All nodes will this shape and colour
edge [color=Blue, style=dashed] // All the lines look like this
Headteacher->{Deputy1 Deputy2 BusinessManager}
Deputy1->{Teacher1 Teacher2}
BusinessManager->ITManager
{rank=same;ITManager Teacher1 Teacher2} // Put them on the same level
}
More information about graphviz syntax here
gantt
title A Gantt Diagram
section Section
A task: a1, 2014-01-01, 30d
Another task: after a1, 20d
section Another
Task in sec: 2014-01-12, 12d
Another task: 24d
More information about mermaid syntax here
Unlike HedgeDoc (which uses mermaid version 9.1.7), this static renderer uses 11.2.0.
X:1
T:Speed the Plough
M:4/4
C:Trad.
K:G
|:GABc dedB|dedB dedB|c2ec B2dB|c2A2 A2BA|
GABc dedB|dedB dedB|c2ec B2dB|A2F2 G4:|
|:g2gf gdBd|g2f2 e2d2|c2ec B2dB|c2A2 A2df|
g2gf g2Bd|g2f2 e2d2|c2ec B2dB|A2F2 G4:|
More information about abc syntax here
start
if (condition A) then (yes)
:Text 1;
elseif (condition B) then (yes)
:Text 2;
stop
elseif (condition C) then (yes)
:Text 3;
elseif (condition D) then (yes)
:Text 4;
else (nothing)
:Text else;
endif
stop{
"$schema": "https://vega.github.io/schema/vega-lite/v4.json",
"data": {"url": "https://vega.github.io/editor/data/barley.json"},
"mark": "bar",
"encoding": {
"x": {"aggregate": "sum", "field": "yield", "type": "quantitative"},
"y": {"field": "variety", "type": "nominal"},
"color": {"field": "site", "type": "nominal"}
}
}
-oO-*-
--o-o-
-o-oo-
-o-oO-
-oo-o-
-*O-o-
3
More information about sequence diagrams syntax here. More information about flow charts syntax here. More information about graphviz syntax here More information about mermaid syntax here More information about abc syntax here More information about vega syntax here More information about fretboard syntax here
:::success Yes 🎉 :::
:::info This is a message 📣 :::
:::warning Watch out ⚡ :::
:::danger Oh No! 🔥 :::
:::spoiler Click to show details You found me 😜 :::
:::spoiler {state="open"} Expand the spoiler container by default You found me 😜 :::
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading(c) (C) (r) (R) (tm) (TM) (p) (P) +-
test.. test... test.... test..... test?..... test!....
!!!!!! ???? ,,
Remarkable---no, awesome!
During 1980--1988.
"Smartypants, double quotes"
'Smartypants, single quotes'
This is bold text
This is bold text
This is italic text
This is italic text
Deleted text
lulala
Superscript: 19^th^
Subscript: H2O
++Inserted text++
==Marked text==
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
- Create a list by starting a line with
+,-, or* - Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Marker character change forces new list start:
- Very easy!
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-
Aenean commodo ligula eget dolor
-
You can use sequential numbers...
-
...or keep all the numbers as
1. -
Aenean massa
-
Cum sociis natoque penatibus
-
Magnis dis parturient montes
-
Nascetur ridiculus mus
-
Donec quam felis
Start numbering with offset:
- foo
- bar
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code "fences"
Sample text here...
Syntax highlighting
var foo = function (bar) {
return bar++;
};
console.log(foo(5));| 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. |
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. |
Left 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. |
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. |
link text link with title Autoconverted link https://github.com/nodeca/pica
With a title:
Like links, images also have a footnote style syntax with a reference later in the document defining the URL location:
Show the image with given size: 
Footnote 1 link1. Footnote 2 link2. Inline footnote^[Text of inline footnote] definition. Duplicated footnote reference2.
Term 1
: Definition 1 with lazy continuation.
Term 2 with inline markup
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Compact style:
Term 1 ~ Definition 1
Term 2 ~ Definition 2a ~ Definition 2b
This is an HTML abbreviation example. It converts "HTML", but keeps intact partial entries like "xxxHTMLyyy" and so on.
*[HTML]: Hyper Text Markup Language
When changes are made to a note previous versions of the note are stored as Revisions, if you ever need to return to a previous save you can find all the note revisions by going to Menu -> Revision.
The note history on the left displays each revision with a timestamp allowing you to quickly select a revision for the desired date and time. Selecting a revision on the left will display the revised note to the right, the revision will display the changes made with colorization to indicate additions/removals.
In addition to browsing the revisions, you can download a selected note revision or revert the current note to the selected revision.