| example | ||
| gsitegen | ||
| tests | ||
| .gitignore | ||
| README.md | ||
| setup.py | ||
| tox.ini | ||
Static Site Generator
Generates simple webpages.
How to use
- Create a file with
.pageextension in the same directory asgenerate.py, the file name will be title of the page, for example: About.page - Use markdown in the created file, it will be auto-converted to HTML. You can also use raw HTML in the file, with
>symbol, like this:
**Example**
>
<p>Hello world</p>
**Back to just markdown**
Line before HTML code must be a single character > and HTML code below must be indented by 2 spaces. You can also use Markdown inside HTML, for example:
<p>**Hello world**<p>
will display as bold.
- (Optional) Create a file called
navbarand/orfooterto have a navigation bar/footer that is added to every generated page file. Example navbar file: (See example/resources/style.css for styling dropdown)
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.
-
(Optional) Add
resourcesfolder, its contents will be copied to generated site's folder. You can create subfolders in it that have the same name as a specific.pagefile, in order to put resources in that page's folder. Note: folder name must be lowercase and spaces must be replaced with-character. -
Run generate.py, it will generate output website files in
website-outputfolder.
To-do list
- 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)