Update README.md
This commit is contained in:
parent
5869d0ebc7
commit
150a81ffd0
13
README.md
13
README.md
@ -16,17 +16,18 @@ Line before HTML code must be a single character `>` and HTML code below must be
|
||||
```
|
||||
will display as bold.
|
||||
|
||||
3. (Optional) Create a file called `navbar` to have a navigation bar that is added to every generated page file. Example navbar file:
|
||||
3. (Optional) Create a file called `navbar` and/or `footer` to have a navigation bar/footer that is added to every generated page file. Example navbar file:
|
||||
```
|
||||
[Home](/)
|
||||
[About](/about)
|
||||
```
|
||||
It also supports HTML, but HTML code will not be formatted as navigation bar automatically.
|
||||
|
||||
4. Run generate.py, it will generate output website files in `website-output` folder.
|
||||
4. (Optional) Add `resources` folder, its contents will be copied to generated site's folder. You can create subfolders in it that have the same name as a specific `.page` file, in order to put resources in that page's folder.
|
||||
Note: folder name must be lowercase and spaces must be replaced with `-` character.
|
||||
|
||||
5. Run generate.py, it will generate output website files in `website-output` folder.
|
||||
|
||||
# To-do list
|
||||
1. Better styling support for navigation bar, etc.
|
||||
2. Footer support, similar to navigation bar.
|
||||
3. Adding images, other resources support.
|
||||
4. Delete removed page files from website-output during next site generation (Last, to be done on release, so it doesn't disturb development)
|
||||
- Better styling support for navigation bar, footer etc.
|
||||
- Delete removed page files from website-output during next site generation (Last, to be done on release, so it doesn't disturb development)
|
||||
|
Loading…
Reference in New Issue
Block a user