diff --git a/README.md b/README.md index aadcee5..b2c78e8 100644 --- a/README.md +++ b/README.md @@ -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: ``` -[Home](/) -[About](/about) +Home;Home.page +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. @@ -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. # 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)