You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Govindas 0efdbbd8b4
Fix dropdown with no link being clickable, was breaking mobile support & edit README.md
5 months ago
example Use :: instead of ; for navbar (less conflicts). And update readme. 5 months ago
gsitegen Fix dropdown with no link being clickable, was breaking mobile support & edit README.md 5 months ago
tests Work with current dir, exit if no pages found 12 months ago
.gitignore Better navbar styling support 1 year ago
README.md Fix dropdown with no link being clickable, was breaking mobile support & edit README.md 5 months ago
setup.py Fix description 1 year ago
tox.ini Setup Python project template. 1 year ago

README.md

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?