depau/HackMD
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Some minor improvements to the yaml-metadata docs

Browse source 
Switching form XAML to YAML syntax highlighting and fixing some grammar.

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
This commit is contained in:
Sheogorath 2018-11-10 22:12:36 +01:00
parent 3020c11d11
commit 43021283e4
No known key found for this signature in database
GPG key ID: 1F05CC3635CDDFFD
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
public/docs/yaml-metadata.md
View file

@ -25,7 +25,7 @@ This option will set the note title which prior than content title.
> default: not set > default: not set
**Example** **Example**
```xml ```yml
title: meta title title: meta title
``` ```
@ -36,7 +36,7 @@ This option will set the note description.
> default: not set > default: not set
**Example** **Example**
```xml ```yml
description: meta description description: meta description
``` ```
@ -47,7 +47,7 @@ This option will set the tags which prior than content tags.
> default: not set > default: not set
**Example** **Example**
```xml ```yml
tags: features, cool, updated 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 > default: not set
**Example** **Example**
```xml ```yml
robots: noindex, nofollow 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) > default: not set (which will be en)
**Example** **Example**
```xml ```yml
langs: ja-jp langs: ja-jp
``` ```
dir 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`. You can only use whether `rtl` or `ltr`.
Look more at here: Look more at here:
http://www.w3.org/International/questions/qa-html-dir 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) > default: not set (which will be ltr)
**Example** **Example**
```xml ```yml
dir: rtl dir: rtl
``` ```
@ -102,29 +102,29 @@ You can only use whether `true` or `false`.
> default: not set (which will be true) > default: not set (which will be true)
**Example** **Example**
```xml ```yml
breaks: false breaks: false
``` ```
GA 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) > default: not set (which won't enable)
**Example** **Example**
```xml ```yml
GA: UA-12345667-8 GA: UA-12345667-8
``` ```
disqus 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) > default: not set (which won't enable)
**Example** **Example**
```xml ```yml
disqus: codimd disqus: codimd
``` ```
@ -135,13 +135,13 @@ This option allows you to switch the document view to the slide preview, to simp
> default: not set > default: not set
**Example:** **Example:**
```xml ```yml
type: slide type: slide
``` ```
slideOptions 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: Please below document for more details:
https://github.com/hakimel/reveal.js/#configuration https://github.com/hakimel/reveal.js/#configuration
@ -153,7 +153,7 @@ https://github.com/hakimel/reveal.js/tree/master/css/theme
> default: not set (which use default slide options) > default: not set (which use default slide options)
**Example** **Example**
```xml ```yml
slideOptions: slideOptions:
transition: fade transition: fade
theme: white theme: white