Govindas
/
SiteGenerator
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README to reflect latest features

This commit is contained in:
Govindas 2022-02-07 14:24:20 +02:00
parent f4de859172
commit dc78ed72b5
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -18,8 +18,13 @@ will display as bold.
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: 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](/) Home;Home.page
[About](/about) About;About.page
External Site;https://example.com
Dropdown;#|
Site 1;https://example1.com
Site 2;https://example2.com
FAQ;FAQ.page
``` ```
It also supports HTML, but HTML code will not be formatted as navigation bar automatically. It also supports HTML, but HTML code will not be formatted as navigation bar automatically.
@ -29,5 +34,5 @@ Note: folder name must be lowercase and spaces must be replaced with `-` charact
5. Run generate.py, it will generate output website files in `website-output` folder. 5. Run generate.py, it will generate output website files in `website-output` folder.
# To-do list # To-do list
- Better styling support for navigation bar, footer etc. - Re-think footer
- Delete removed page files from website-output during next site generation (Last, to be done on release, so it doesn't disturb development) - Delete removed page files from website-output during next site generation (Last, to be done on release, so it doesn't disturb development)