diff options
Diffstat (limited to '')
| -rw-r--r-- | public/docs/features.md | 26 | ||||
| -rw-r--r-- | public/docs/release-notes.md | 49 | ||||
| -rw-r--r-- | public/docs/slide-example.md | 3 | ||||
| -rw-r--r-- | public/docs/yaml-metadata.md | 39 |
4 files changed, 97 insertions, 20 deletions
diff --git a/public/docs/features.md b/public/docs/features.md index f684ca62..a4ffb633 100644 --- a/public/docs/features.md +++ b/public/docs/features.md @@ -8,7 +8,7 @@ This means that you can write notes with other people on your **desktop**, **tab 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**](https://github.com/hackmdio/codimd/issues). -Or meet us on [**Matrix.org**](https://riot.im/app/#/room/#codimd:matrix.org) or [**Gitter**](https://gitter.im/hackmdio/hackmd) for dev-talk and interactive help. +Or meet us on [**Matrix.org**](https://riot.im/app/#/room/#codimd:matrix.org) for dev-talk and interactive help. **Thank you very much!** Workspace @@ -72,9 +72,11 @@ Notes can be embedded as follows: ## [Slide Mode](./slide-example): You can use a special syntax to organize your note into slides. -After that, you can use the **Slide Mode** <i class="fa fa-tv"></i> to make a presentation. +After that, you can use the **[Slide Mode](./slide-example)** <i class="fa fa-tv"></i> to make a presentation. Visit the above link for details. +To switch the editor into slide mode, set the [document type](./yaml-metadata#type) to `slide`. + View === ## Table of Contents: @@ -88,9 +90,23 @@ You can hover and click <i class="fa fa-chain"></i> to anchor on it. Edit: === +## Editor Modes: +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: + +- sublime (default) +- emacs +- vim + ## Shortcut Keys: -Just like Sublime text, which is pretty quick and convenient. -> For more infomation, see [here](https://codemirror.net/demo/sublime.html). +The shortcut keys depend on your selected editor mode. By default they are just like Sublime text, which is pretty quick and convenient. +> For more information, see [here](https://codemirror.net/demo/sublime.html). + +For emacs: +> For more information, see [here](https://codemirror.net/demo/emacs.html). + +For vim: +> For more information, see [here](https://codemirror.net/demo/vim.html). ## Auto-Complete: This editor provides full auto-complete hints in markdown. @@ -195,7 +211,7 @@ When you’re a carpenter making a beautiful chest of drawers, you’re not goin ## Externals ### YouTube -{%youtube 1G4isv_Fylg %} +{%youtube aqz-KE-bpKQ %} ### Vimeo {%vimeo 124148255 %} diff --git a/public/docs/release-notes.md b/public/docs/release-notes.md index 66202009..c775b70a 100644 --- a/public/docs/release-notes.md +++ b/public/docs/release-notes.md @@ -1,6 +1,55 @@ Release Notes === +<i class="fa fa-tag"></i> 1.2.1 <i class="fa fa-clock-o"></i> 2018-09-26 00:00 +--- + +### Enhancements +* Update Italian translations +* Update Japanese translations +* Update markdown-pdf +* Add support for unix sockets +* Update "follow us" information to Community channel and translation +* Add Cloudron installation method +* Add guide for Mattermost authentication +* Update various packages +* Add Indonesian language as new translation + +### Fixes +* Fix content types in status router +* Fix some modal colors in night mode +* Fix CSP to allow usage of speaker notes +* Fix some wrong title attributes in the editor toolbar +* Fix some confusion about the default location of images. It's always the local filesystem now +* Fix object handling in avatar generation code +* Finally fix error handling of LZ-String by using self-maintained version +* Fix migration handling +* Fix gitlab API version +* Fix some server crashes caused by PDF creation +* Fix document length limit on post to `/new` +* Fix broken youtube embedding on `/features` page + +### Refactors +* Refactor generation of table of contents +* Refactor "copyright"-section to be a "Powered by" + +### Removes +* Remove unneeded inline styling + +### Deprecations +* NodeJS version 6 +* Mattermost login integration (is replaced by [generic oAuth2 module](https://github.com/hackmdio/codimd/blob/6ce7b20a7f92ccff2f7f870ff5d116d685310cfd/docs/guides/auth/mattermost-self-hosted.md)) + +### Honorable mentions +* [Alex Hesse (Pingu501)](https://github.com/Pingu501) +* [Alexander Wellbrock (w4tsn)](https://github.com/w4tsn) +* [Cédric Couralet (micedre)](https://github.com/micedre) +* [Girish Ramakrishnan (gramakri)](https://github.com/gramakri) +* [maahl](https://github.com/maahl) +* [Max Wu (jackycute)](https://github.com/jackycute) +* [Miranda (ahihi)](https://github.com/ahihi) +* [Ondřej Slabý (maxer456)](https://github.com/maxer456) + <i class="fa fa-tag"></i> 1.2.0 <i class="fa fa-clock-o"></i> 2018-06-28 00:00 --- diff --git a/public/docs/slide-example.md b/public/docs/slide-example.md index 411f31d4..49503669 100644 --- a/public/docs/slide-example.md +++ b/public/docs/slide-example.md @@ -1,4 +1,5 @@ --- +type: slide slideOptions: transition: slide --- @@ -270,7 +271,7 @@ Press `B` or `.` on your keyboard to pause the presentation. This is helpful whe Down below you can find a print icon<i class="fa fa-fw fa-print"></i>. -After you click on it, use the print function of your browser (either CTRL+P or cmd+P) to print the slides as PDF. +After you click on it, use the print function of your browser (either CTRL+P or cmd+P) to print the slides as PDF. [See official reveal.js instructions for details](https://github.com/hakimel/reveal.js#instructions-1) --- diff --git a/public/docs/yaml-metadata.md b/public/docs/yaml-metadata.md index 888345f7..839616a8 100644 --- a/public/docs/yaml-metadata.md +++ b/public/docs/yaml-metadata.md @@ -25,7 +25,7 @@ This option will set the note title which prior than content title. > default: not set **Example** -```xml +```yml title: meta title ``` @@ -36,7 +36,7 @@ This option will set the note description. > default: not set **Example** -```xml +```yml description: meta description ``` @@ -47,7 +47,7 @@ This option will set the tags which prior than content tags. > default: not set **Example** -```xml +```yml tags: features, cool, updated ``` @@ -62,7 +62,7 @@ So you can prevent any search engine index your note by set `noindex, nofollow`. > default: not set **Example** -```xml +```yml robots: noindex, nofollow ``` @@ -75,13 +75,13 @@ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes > default: not set (which will be en) **Example** -```xml +```yml langs: ja-jp ``` dir --- -This option provide to describe the direction of the text in this note. +This option specifies 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 @@ -89,7 +89,7 @@ http://www.w3.org/International/questions/qa-html-dir > default: not set (which will be ltr) **Example** -```xml +```yml dir: rtl ``` @@ -102,35 +102,46 @@ You can only use whether `true` or `false`. > default: not set (which will be true) **Example** -```xml +```yml breaks: false ``` GA --- -This option allow you to enable Google Analytics with your ID. +This option allows you to enable Google Analytics with your ID. > default: not set (which won't enable) **Example** -```xml +```yml GA: UA-12345667-8 ``` disqus --- -This option allow you to enable Disqus with your shortname. +This option allows you to enable Disqus with your shortname. > default: not set (which won't enable) **Example** -```xml +```yml disqus: codimd ``` +type +--- +This option allows you to switch the document view to the slide preview, to simplify live editing of presentations. + +> default: not set + +**Example:** +```yml +type: slide +``` + slideOptions --- -This option allow you provide custom options to slide mode. +This option allows you to provide custom options to slide mode. Please below document for more details: https://github.com/hakimel/reveal.js/#configuration @@ -142,7 +153,7 @@ https://github.com/hakimel/reveal.js/tree/master/css/theme > default: not set (which use default slide options) **Example** -```xml +```yml slideOptions: transition: fade theme: white |