Skip to content

Commit

Permalink
version 1.1 - YAML metadata block
Browse files Browse the repository at this point in the history
  • Loading branch information
ValeryBruniaux committed Feb 27, 2020
1 parent af06d83 commit c28cbf9
Show file tree
Hide file tree
Showing 16 changed files with 636 additions and 165 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,31 +38,31 @@ If you want to use equations, you need **internet access** to reach the transfor

# Syntax for markdown file ?

## Header and Pandoc Title Block
## Header and Yaml Metadata Block

All [pandoc extensions](https://pandoc.org/MANUAL.html#pandocs-markdown) for markdown are usable (equation, emoji, tables, ...)

At the beginning of markdown file put a [Pandoc Title Block](https://pandoc.org/MANUAL.html#metadata-blocks) to describe your document like this :
At the beginning of markdown file put a [Yaml Metadata Block](https://pandoc.org/MANUAL.html#extension-yaml_metadata_block) to describe your document like this :

```yaml
---
title : The Wonderful title
author : My Name
date : 20/04/2018
what : you want
---
```
% The Wonderful title
% My Name
% 20/04/2018
```

This block supports multilines :
**After a blank line** you can write your document using markdown syntax. Look example files in examples directory.

⚠️ This version 1.1 the default template no longer includes title at the beginning of the document.
You can use the `auto_title.template` that works like in previous version.
Or you can write title like in old template with (no number and title class) :

```
% The Wonderful title
You can have a multilines title like this
% My Name
And my friend
And another one
% 20/04/2018
# Your nice title {- .title}
```

**After a blank line** you can write your document using markdown syntax. Look example files in examples directory.

## Pandoc Markdown extensions

You can edit your text using the [standard Markdown syntax](http://commonmark.org/help/).
Expand Down
1 change: 1 addition & 0 deletions css/default.css
23 changes: 23 additions & 0 deletions css/retenir.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/* Author : Valéry Bruniaux
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
@import url("lesson.css");

ul > li:before {
font-size: 1.1em;
content: "❑";
content: "➫";
}

Loading

0 comments on commit c28cbf9

Please sign in to comment.