From 82beabb1ccede6efa441b8fefda84d536eb9e436 Mon Sep 17 00:00:00 2001 From: gurkenhabicht Date: Sun, 25 Sep 2022 19:30:19 +0200 Subject: [PATCH] more Readme --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 07e36f9..479e45a 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,37 @@ -# husk +# 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 -* 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 - +* 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 your git repository +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 visting `localhost:5000` +* Debug as __dynamic website__ via running `./start.sh` and vist `localhost:5000` -* Debug the __static website__ after you did the build via +* Debug the __static website__ after you did the build via following commands and vist `localhost:8000` ```sh cd build/ python3 -m http.server