Commit 09a8673a authored by berumuron's avatar berumuron
Browse files

doc: Update few errors in README.md

parent a8a34a6f
......@@ -47,9 +47,9 @@ that you can upload on your server.
```console
$ tree
.
├── index.html
└── site
└── index.html
├── site
│   └── index.html
└── index.html
```
Well OK, Boop! basically just copied the `index.html` file under the `site`
......@@ -200,13 +200,15 @@ $ tree
├── site
│   ├── feeds
│   │   └── all.atom.xml
│   ├── blog.html
│   ├── index.html
│   ├── my-article.html
│   └── style.css
├── static
│   └── style.css
├── templates
│   └── article.html
│   ├── article.html
│   └── blog.html
└── index.html
```
......@@ -265,13 +267,15 @@ $ tree
│   │   └── all.atom.xml
│   ├── foo
│   │   └── index.html
│   ├── blog.html
│   ├── index.html
│   ├── my-article.html
│   └── style.css
├── static
│   └── style.css
├── templates
│   └── article.html
│   ├── article.html
│   └── blog.html
├── configuration.yml
└── index.html
```
......@@ -282,6 +286,7 @@ The file's content is accessible through the `PAGE_CONTENT` variable.
```console
$ echo '<html><body>{{ PAGE_CONTENT }}</body></html>' > templates/page.html
$ echo 'My page' > pages/foo/index.html
$ boop.py
$ cat site/foo/index.html
<html><body>My page</body></html>
```
......@@ -334,8 +339,12 @@ This will generate the `site/my_page.html` file:
</html>
```
You can override the default template by setting a `template` variable in the
Yaml header of pages and articles.
Please note if you make use of a variable in the template, it must be defined
in all pages then (for example, we must add a `title` variable to all the pages
we created until now).
You can also override the default template by setting a `template` variable in
the Yaml header of pages and articles.
## Template syntax
......@@ -392,5 +401,5 @@ There are some tests (i.e. doctests) that can be run to check that everything
works smoothly. They can be executed with:
```console
$ python3 -m doctest -v boop.py
$ python3 -m doctest -vf */*.py
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment