From 2a2daaa42dfba9f5aac99a9088b7382a0eee59e5 Mon Sep 17 00:00:00 2001 From: User Identifier Date: Fri, 17 Nov 2017 10:42:46 +0100 Subject: [PATCH] Add example folder --- README.md | 56 +++++++--------------------------------- example/markdown/test.md | 8 ++++++ example/template.html | 10 +++++++ 3 files changed, 28 insertions(+), 46 deletions(-) create mode 100644 example/markdown/test.md create mode 100644 example/template.html diff --git a/README.md b/README.md index 8f65706..ce118fc 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,17 @@ # Ciclostile - -## TODO - -- select input and output folders and template by parameters or config file. - - -## Example - -Input markdown: - -```markdown -Title: Home Page - -# Site - -Some text +To install dependencies: +``` +pip install -r requirements.txt ``` +Look at the `example` folder to see how to setup a project. -Template: - -```html - - - - {{ title }} - - - -{{ content }} - - - +To build the example: +``` +cd example +mkdir target +../ciclostile.py ``` -Output html: - -```html - - - - Home Page - - - -

Site

-

Some text

- - - -``` +In the `target` folder should now appear `test.html` diff --git a/example/markdown/test.md b/example/markdown/test.md new file mode 100644 index 0000000..1f32829 --- /dev/null +++ b/example/markdown/test.md @@ -0,0 +1,8 @@ +Title: Home Page +Author: anon + + +# Site + +Some text + diff --git a/example/template.html b/example/template.html new file mode 100644 index 0000000..5cbc86d --- /dev/null +++ b/example/template.html @@ -0,0 +1,10 @@ + + + + {{ title }} + + + + {{ content }} + +