mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-12-28 08:02:07 +00:00
332 lines
No EOL
5.1 KiB
Markdown
332 lines
No EOL
5.1 KiB
Markdown
Features
|
|
===
|
|
### Embed HackMD
|
|
```html
|
|
<iframe width="100%" height="500" src="http://hackmd.herokuapp.com/features" frameborder="0">
|
|
</iframe>
|
|
```
|
|
|
|
### Emoji
|
|
:smile: :smiley: :cry:
|
|
|
|
### Todo List
|
|
- [ ] Not
|
|
- [ ] No yet
|
|
- asd
|
|
- [ ] right away
|
|
- [x] Done
|
|
- Test
|
|
- [x] yes
|
|
- asd
|
|
- [x] cool
|
|
- Test
|
|
- asd
|
|
- qwe
|
|
- vgfhddfgh
|
|
- jhlkj
|
|
- jkhkjh
|
|
- kjhgkh
|
|
- gkjhgkj
|
|
|
|
### Code Highlighting
|
|
```javascript
|
|
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;
|
|
}
|
|
}
|
|
```
|
|
#### with line number
|
|
> add '=' after the code block lang
|
|
|
|
```javascript=
|
|
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;
|
|
}
|
|
}
|
|
```
|
|
|
|
smartList
|
|
---
|
|
#### cool
|
|
|
|
* XD
|
|
* QQ
|
|
|
|
|
|
1. yes
|
|
2. no
|
|
|
|
smartypants
|
|
---
|
|
- "asd"
|
|
- --asd
|
|
- asd---
|
|
|
|
Table
|
|
---
|
|
First Header | Second Header
|
|
------------- | -------------
|
|
Content Cell | Content Cell
|
|
Content Cell | Content Cell
|
|
|
|
First Header | Second Header
|
|
------------- | -------------
|
|
|
|
Image
|
|
---
|
|
|
|
|
|
Video
|
|
---
|
|
#### Youtube
|
|
|
|
{%youtube 1G4isv_Fylg %}
|
|
|
|
#### Vimeo
|
|
|
|
{%vimeo 124148255 %}
|
|
|
|
Gist
|
|
---
|
|
{%gist schacon/4277 %}
|
|
|
|
tags
|
|
---
|
|
> using like below
|
|
|
|
###### tags: `features` `cool`
|
|
|
|
|
|
|
|
|
|
|
|
# h1 Heading
|
|
## h2 Heading
|
|
### h3 Heading
|
|
#### h4 Heading
|
|
##### h5 Heading
|
|
###### h6 Heading
|
|
|
|
|
|
## Horizontal Rules
|
|
|
|
___
|
|
|
|
---
|
|
|
|
***
|
|
|
|
|
|
## Typographic replacements
|
|
|
|
Enable typographer option to see result.
|
|
|
|
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
|
|
|
|
test.. test... test..... test?..... test!....
|
|
|
|
!!!!!! ???? ,,
|
|
|
|
Remarkable -- awesome
|
|
|
|
"Smartypants, double quotes"
|
|
|
|
'Smartypants, single quotes'
|
|
|
|
|
|
## Emphasis
|
|
|
|
**This is bold text**
|
|
|
|
__This is bold text__
|
|
|
|
*This is italic text*
|
|
|
|
_This is italic text_
|
|
|
|
~~Deleted text~~
|
|
|
|
Superscript: 19^th^
|
|
|
|
Subscript: H~2~O
|
|
|
|
++Inserted text++
|
|
|
|
==Marked text==
|
|
|
|
|
|
## Blockquotes
|
|
|
|
|
|
> Blockquotes can also be nested...
|
|
>> ...by using additional greater-than signs right next to each other...
|
|
> > > ...or with spaces between arrows.
|
|
|
|
|
|
## Lists
|
|
|
|
Unordered
|
|
|
|
+ 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
|
|
+ Very easy!
|
|
|
|
Ordered
|
|
|
|
1. Lorem ipsum dolor sit amet
|
|
2. Consectetur adipiscing elit
|
|
3. Integer molestie lorem at massa
|
|
|
|
|
|
1. You can use sequential numbers...
|
|
1. ...or keep all the numbers as `1.`
|
|
|
|
Start numbering with offset:
|
|
|
|
57. foo
|
|
1. bar
|
|
|
|
|
|
## Code
|
|
|
|
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
|
|
|
|
``` js
|
|
var foo = function (bar) {
|
|
return bar++;
|
|
};
|
|
|
|
console.log(foo(5));
|
|
```
|
|
|
|
## Tables
|
|
|
|
| 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. |
|
|
|
|
|
|
## Links
|
|
|
|
[link text](http://dev.nodeca.com)
|
|
|
|
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
|
|
|
|
Autoconverted link https://github.com/nodeca/pica
|
|
|
|
|
|
## Images
|
|
|
|
|
|
|
|
|
|
Like links, Images also have a footnote style syntax
|
|
|
|
![Alt text][id]
|
|
|
|
With a reference later in the document defining the URL location:
|
|
|
|
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
|
|
|
|
|
|
## Footnotes
|
|
|
|
Footnote 1 link[^first].
|
|
|
|
Footnote 2 link[^second].
|
|
|
|
Inline footnote^[Text of inline footnote] definition.
|
|
|
|
Duplicated footnote reference[^second].
|
|
|
|
[^first]: Footnote **can have markup**
|
|
|
|
and multiple paragraphs.
|
|
|
|
[^second]: Footnote text.
|
|
|
|
|
|
## Definition lists
|
|
|
|
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
|
|
|
|
|
|
## Abbreviations
|
|
|
|
This is HTML abbreviation example.
|
|
|
|
It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
|
|
|
|
*[HTML]: Hyper Text Markup Language |