diff options
Diffstat (limited to '')
-rw-r--r-- | public/docs/features.md (renamed from public/features.md) | 52 | ||||
-rw-r--r-- | public/docs/slide-example.md | 81 | ||||
-rw-r--r-- | public/docs/yaml-metadata.md | 97 |
3 files changed, 223 insertions, 7 deletions
diff --git a/public/features.md b/public/docs/features.md index dde852f0..a734f3c2 100644 --- a/public/features.md +++ b/public/docs/features.md @@ -3,7 +3,7 @@ Features Introduction === -<i class="fa fa-file-text"></i> HackMD is a realtime collaborate markdown note in all platforms. +<i class="fa fa-file-text"></i> **HackMD** is a realtime collaborate markdown note in all platforms. This mean you can do some notes with any other in **Desktop, Tablet or even Phone**. You can Sign in via **Facebook, Twitter, GitHub, Dropbox** in the **[homepage](/)**. @@ -37,11 +37,11 @@ If you want to share a **editable** note, just copy the url. If you want to share a **read-only** note, simply press share button <i class="fa fa-share-alt"></i> and copy the url. ## Save -Currently, you can save to **dropbox** <i class="fa fa-dropbox"></i> or save as **.md** <i class="fa fa-file-text"></i> to local. +Currently, you can save to **Dropbox** <i class="fa fa-dropbox"></i> or save as **.md** <i class="fa fa-file-text"></i> to local. ## Import -Like save feature, you can also import **.md** from **dropbox** <i class="fa fa-dropbox"></i>. -Or import from your **clipboard** <i class="fa fa-clipboard"></i>, and that can parse some **html** which might be useful :smiley: +Like save feature, you can also import **.md** from **Dropbox** <i class="fa fa-dropbox"></i>. +Or import from your **Clipboard** <i class="fa fa-clipboard"></i>, and that can parse some **html** which might be useful :smiley: ## Permission There is a little button on the top right of the view. @@ -60,6 +60,11 @@ It might be one of below: <iframe width="100%" height="500" src="http://hackmd.io/features" frameborder="0"></iframe> ``` +## [Slide Mode](./slide-example) +You can use some syntax to divide your note into slides. +Then use **Slide Mode** <i class="fa fa-tv"></i> to made a presentation. +Visit above link for detail. + View === ## Table of content @@ -93,12 +98,13 @@ This will take the first **level 1 header** as the note title. Using tags like below, these will show in your **history**. ###### tags: `features` `cool` `updated` -## [YAML metadata](https://hackmd.io/IwFgZgxiBsBGCsBaAnPYAORJm07gDMImGAKYnrwDsUI8QA==) +## [YAML metadata](./yaml-metadata) Provide advanced note information to set the browse behavior, visit above link for detail -- robots: set search engine to index or not +- robots: set web robots meta - lang: set browse language - dir: set text direction -- breaks: set to use line breaks +- breaks: set to use line breaks or not +- mathjax: set to parse mathjax or not ## Emoji You can type any emoji like this :smile: :smiley: :cry: :wink: @@ -241,9 +247,41 @@ digraph hierarchy { } ``` +### Mermaid +```mermaid +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 + anther task : 24d +``` + > More information about **Sequence diagrams** syntax [here](http://bramp.github.io/js-sequence-diagrams/). > More information about **Flow charts** syntax [here](http://adrai.github.io/flowchart.js/). > More information about **Graphviz** syntax [here](http://www.tonyballantyne.com/graphs.html) +> More information about **Mermaid** syntax [here](http://knsv.github.io/mermaid) + +Alert area +--- +:::success +Yes :tada: +::: + +:::info +This is a message :mega: +::: + +:::warning +Watch out :zap: +::: + +:::danger +Oh No :fire: +::: ## Typography diff --git a/public/docs/slide-example.md b/public/docs/slide-example.md new file mode 100644 index 00000000..3d9a70c4 --- /dev/null +++ b/public/docs/slide-example.md @@ -0,0 +1,81 @@ +Slide example +=== +This feature still in beta, may have some issues. + +For details: +https://github.com/hakimel/reveal.js/ + +--- + +## First slide + +`---` + +Is the divder of slides + +---- + +### First branch of fisrt slide + +`----` + +Is the divder of branches + +---- + +### Second branch of first slide + +`<!-- .element: class="fragment" data-fragment-index="1" -->` + +Is the fragment syntax + +- Item 1<!-- .element: class="fragment" data-fragment-index="1" --> +- Item 2<!-- .element: class="fragment" data-fragment-index="2" --> + +--- + +## Second slide + +<!-- .slide: data-background="#1A237E" --> + +`<!-- .slide: data-background="#1A237E" -->` + +Is the background syntax + +--- + +<!-- .slide: data-transition="zoom" --> + +`<!-- .slide: data-transition="zoom" -->` + +Is the transition syntax + +you can use: +none/fade/slide/convex/concave/zoom + +--- + +<!-- .slide: data-transition="fade-in convex-out" --> + +`<!-- .slide: data-transition="fade-in convex-out" -->` + +Also can set different in/out transition + +you can use: +none/fade/slide/convex/concave/zoom +postfix with `-in` or `-out` + +--- + +<!-- .slide: data-transition-speed="fast" --> + +`<!-- .slide: data-transition-speed="fast" -->` + +Custom the transition speed! + +you can use: +default/fast/slow + +--- + +# The End
\ No newline at end of file diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md new file mode 100644 index 00000000..5fc6e1b8 --- /dev/null +++ b/public/docs/yaml-metadata.md @@ -0,0 +1,97 @@ +--- +robots: index, follow +lang: en +dir: ltr +breaks: true +--- + +Supported YAML metadata +=== + +First you need to insert syntax like this at the **start** of the note: +``` +--- +YAML metas +--- +``` + +Replace the "YAML metas" in this section with any YAML options as below. +You can also refer to this note's source code. + +robots +--- +This option will give below meta in the note head meta: +```xml +<meta name="robots" content="your_meta"> +``` +So you can prevent any search engine index your note by set `noindex, nofollow`. + +> default: not + +**Example** +```xml +robots: noindex, nofollow +``` + +lang +--- +This option will set the language of the note, that might alter some typography of it. +You can find your the language code in ISO 639-1 standard: +https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes + +> default: not set (which will be en) + +**Example** +```xml +langs: ja-jp +``` + +dir +--- +This option provide to describe the direction of the text in this note. +You can only use whether `rtl` or `ltr`. +Look more at here: +http://www.w3.org/International/questions/qa-html-dir + +> default: not set (which will be ltr) + +**Example** +```xml +dir: rtl +``` + +breaks +--- +This option means the hardbreaks in the note will be parsed or be ignore. +The original markdown syntax breaks only if you put space twice, but HackMD choose to breaks every time you enter a break. +You can only use whether `true` or `false`. + +> default: not set (which will be true) + +**Example** +```xml +breaks: false +``` + +mathjax +--- +This option let you to choose to parse mathjax syntax or not. + +> default: not set (which will be true) + +**Example** +```xml +mathjax: false +``` + +spellcheck +--- +**Warning: Experimental feature!** +This option let you to choose to enable spell checking feature or not. + +> default: not set (which will be false) + +**Example** +```xml +spellcheck: true +```
\ No newline at end of file |