Go to file
2022-09-14 13:02:01 +03:00
example Use :: instead of ; for navbar (less conflicts). And update readme. 2022-09-06 15:05:08 +03:00
gsitegen Fix dropdown with no link being clickable, was breaking mobile support & edit README.md 2022-09-14 13:02:01 +03:00
tests Work with current dir, exit if no pages found 2022-02-17 16:31:58 +02:00
.gitignore Better navbar styling support 2022-02-03 15:34:15 +02:00
README.md Fix dropdown with no link being clickable, was breaking mobile support & edit README.md 2022-09-14 13:02:01 +03:00
setup.py Fix description 2022-01-25 14:47:00 +00:00
tox.ini Setup Python project template. 2022-01-25 14:40:35 +00:00

Static Site Generator

Generates simple webpages.

How to use

  1. Create a file with .page extension, the file name will be title of the page, for example: About Us.page
  2. 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.

  1. (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: (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.

  1. (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.

  2. 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?