Add example folder
This commit is contained in:
parent
104006503e
commit
2a2daaa42d
56
README.md
56
README.md
|
@ -1,53 +1,17 @@
|
||||||
# Ciclostile
|
# Ciclostile
|
||||||
|
|
||||||
|
To install dependencies:
|
||||||
## TODO
|
```
|
||||||
|
pip install -r requirements.txt
|
||||||
- select input and output folders and template by parameters or config file.
|
|
||||||
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
Input markdown:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
Title: Home Page
|
|
||||||
|
|
||||||
# Site
|
|
||||||
|
|
||||||
Some text
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Look at the `example` folder to see how to setup a project.
|
||||||
|
|
||||||
Template:
|
To build the example:
|
||||||
|
```
|
||||||
```html
|
cd example
|
||||||
<!DOCTYPE html>
|
mkdir target
|
||||||
<html>
|
../ciclostile.py
|
||||||
<head>
|
|
||||||
<title>{{ title }}</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
{{ content }}
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Output html:
|
In the `target` folder should now appear `test.html`
|
||||||
|
|
||||||
```html
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>Home Page</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<h1>Site</h1>
|
|
||||||
<p>Some text</p>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
8
example/markdown/test.md
Normal file
8
example/markdown/test.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
Title: Home Page
|
||||||
|
Author: anon
|
||||||
|
|
||||||
|
|
||||||
|
# Site
|
||||||
|
|
||||||
|
Some text
|
||||||
|
|
10
example/template.html
Normal file
10
example/template.html
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>{{ title }}</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
{{ content }}
|
||||||
|
</body>
|
||||||
|
</html>
|
Loading…
Reference in New Issue
Block a user