stefan
/
husk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Builds a website of a git repository file structure and markdown files
6 Commits 1 Branch 0 Tags 2.2 MiB
CSS 57%
Python 18%
HTML 17.8%
JavaScript 7%
Shell 0.2%
Go to file
Stefan Friese 709d4344e6 added toml to pyproject 2022-09-13 23:29:42 +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
…
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 added toml to pyproject 2022-09-13 23:29:42 +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

README.md

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

  1. Clone your git repository
  2. Put its path into settings.toml
  3. Run python3 freezer.py

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

Debugging

  • 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