forked from unit/ciclostile
Add readme with example
This commit is contained in:
parent
7b41841dd2
commit
b8d13bbdbc
53
README.md
Normal file
53
README.md
Normal file
|
@ -0,0 +1,53 @@
|
||||||
|
# Ciclostile
|
||||||
|
|
||||||
|
|
||||||
|
## TODO
|
||||||
|
|
||||||
|
- select input and output folders and template by parameters or config file.
|
||||||
|
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
Input markdown:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Title: Home Page
|
||||||
|
|
||||||
|
# Site
|
||||||
|
|
||||||
|
Some text
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Template:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>{{ title }}</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
{{ content }}
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
Output html:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Home Page</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<h1>Site</h1>
|
||||||
|
<p>Some text</p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user