forked from varia/varia.website
42 lines
893 B
Markdown
42 lines
893 B
Markdown
|
# Creole Reader
|
||
|
|
|
||
|
|
This plugins allows you to write your posts using the wikicreole syntax. Give to
|
||
|
|
these files the creole extension. The metadata are between `<<header>> <</header>>`
|
||
|
|
tags.
|
||
|
|
|
||
|
|
## Dependency
|
||
|
|
This plugin relies on [python-creole](https://pypi.python.org/pypi/python-creole/) to work. Install it with:
|
||
|
|
`pip install python-creole`
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
Use ** for strong, // for emphasis, one = for 1st level titles. Please use the
|
||
|
|
following macro for code highlighting:
|
||
|
|
`<<code ext=".file_extension">> <</code>>`
|
||
|
|
|
||
|
|
For the complete syntax, look at: http://www.wikicreole.org/
|
||
|
|
|
||
|
|
## Basic example
|
||
|
|
```
|
||
|
|
<<header>>
|
||
|
|
title: Créole
|
||
|
|
tags: creole, python, pelican_open
|
||
|
|
date: 2013-12-12
|
||
|
|
<</header>>
|
||
|
|
|
||
|
|
= Title 1
|
||
|
|
== Title 2
|
||
|
|
|
||
|
|
Some nice text with **strong** and //emphasis//.
|
||
|
|
|
||
|
|
* A nice list
|
||
|
|
** With sub-elements
|
||
|
|
* Python
|
||
|
|
|
||
|
|
<<code ext=".py">>
|
||
|
|
print("Hello World")
|
||
|
|
<</code>>
|
||
|
|
|
||
|
|
# An ordered list
|
||
|
|
# A second item
|
||
|
|
```
|