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
20 Commits 1 Branch 0 Tags 2.2 MiB
CSS 57%
Python 18%
HTML 17.8%
JavaScript 7%
Shell 0.2%
Go to file
gurkenhabicht 5d63accc32 reworked all css templates, added max size of boxes 2022-10-11 00:00:05 +02:00
static reworked all css templates, added max size of boxes 2022-10-11 00:00:05 +02:00
templates included settings for theme, project name and title, cleanup 2022-09-25 19:15:31 +02:00
.gitignore Added settings.toml 2022-09-09 15:41:05 +02:00
LICENSE
…
README.md more Readme 2022-09-25 19:30:19 +02:00
freezer.py Added settings.toml 2022-09-09 15:41:05 +02:00
husk_helpers.py added tables extension, sorting of dirs and files in order 2022-09-26 17:15:05 +02:00
pyproject.toml css cleanup 2022-09-22 00:26:16 +02:00
settings.toml included settings for theme, project name and title, cleanup 2022-09-25 19:15:31 +02:00
start.sh css cleanup 2022-09-22 00:26:16 +02:00
start_site.py added tables extension, sorting of dirs and files in order 2022-09-26 17:15:05 +02:00

README.md

Husk

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

  • 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, don't worry about anything else
  • README.md is your frontpage
  • Write documentation in your code repository, let husk deal with the rest. Parses Markdown only, ignores your scripts and code files.
  • Search the files of your documentation live and without a database
  • Builds a TOC of your markdown file as sections of the documentation's website for ease of use
  • Multiple themes included

Usage

To build a static website do the following steps

  1. Clone the git repository of choice containing markdown documentation
  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.

Settings and Themes

Any specifics to your project can be set inside the settings file. Themes for the website can be set here as well. The following themes are included

  • dark-one
  • github-dark
  • solarized-dark
  • solarized-light
  • xcode

Debugging

  • Debug as dynamic website via running ./start.sh and vist localhost:5000

  • Debug the static website after you did the build via following commands and vist localhost:8000

cd build/
python3 -m http.server