Builds a website of a git repository file structure and markdown files

Go to file

Stefan Friese 5f42a5d3db deleted build		2022-09-09 15:43:54 +02:00
static	init	2022-09-02 09:05:59 +02:00
templates	Added settings.toml	2022-09-09 15:41:05 +02:00
.gitignore	Added settings.toml	2022-09-09 15:41:05 +02:00
LICENSE	Initial commit	2022-09-02 09:04:11 +02:00
README.md	Added settings.toml	2022-09-09 15:41:05 +02:00
freezer.py	Added settings.toml	2022-09-09 15:41:05 +02:00
husk_helpers.py	Added settings.toml	2022-09-09 15:41:05 +02:00
pyproject.toml	cleanup	2022-09-06 23:45:26 +02:00
settings.toml	Added settings.toml	2022-09-09 15:41:05 +02:00
start.sh	Added settings.toml	2022-09-09 15:41:05 +02:00
start_site.py	Added settings.toml	2022-09-09 15:41:05 +02:00

husk

Builds a website out of a git repository file structure and markdown files

README.md is your frontpage
The file structure of your git repository is used as a tree strucuture for the website. Build your website through markdown files in your git repository only
Parses Markdown only, ignores your scripts and code files. Write documentation in your code repository, let husk deal with the rest
Search your website's files live and without a database
Builds a TOC of your markdown file as sections of the website for ease of use

Usage

To build a static website do the following steps

There will be a directory called build containing your static website after the script is finished. Copy it to your webserver and enjoy.

Debug as dynamic website via running ./start.sh and visting localhost:5000
Debug the static website after you did the build via

cd build/
python3 -m http.server