example | ||
gsitegen | ||
tests | ||
.gitignore | ||
README.md | ||
setup.py | ||
tox.ini |
Static Site Generator
Generates simple webpages.
How to use
- Create a file with
.page
extension, the file name will be title of the page, for example:About Us.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.
- (Optional) Create a file called
navbar
and/orfooter
to 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
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. -
Run generate.py, it will generate output website files in
website-output
folder.
To-do list
- Re-think footer (it works, but I'm unsure if it is flexible enough)
- Delete removed page files from website-output during next site generation (Last, to be done on release, so it doesn't disturb development)
- Maybe document styling? (div classes: 'content', 'dropdown', 'dropbtn', 'dropdown-content', etc.)
- Custom markdown for colors?