Co-authored-by: GitHub Action <action@github.com>
4.4 KiB
+++ title = "karzok" description = "A theme for your documentation. Fast and secure" template = "theme.html" date = 2022-01-23T23:20:14+01:00
[extra] created = 2022-01-23T23:20:14+01:00 updated = 2022-01-23T23:20:14+01:00 repository = "https://github.com/kogeletey/karzok" homepage = "https://github.com/kogeletey/karzok" minimum_version = "0.0.14" license = "Apache-2.0" demo = "https://fmatch.org/karzok"
[extra.author] name = "Konrad Geletey" homepage = "" +++
Karzok
A theme for your documentation. Fast and secure
Demo
Requirements
Karzok uses npm,zola to dependency managment,rendering, scripts and plugins.
Install
for your platform.
Optional
Get Started
1. Create a new zola site
zola init zola_site
2. Download this theme to you themes directory:
git clone https://git.sr.ht/~kogeletey/karzok zola_site/themes
or install as submodule:
cd zola_site
git init # if your project is a git repository already, ignore this command
git submodule add https://git.sr.ht/~kogeletey/karzok zola_site/themes
3. Configuration. Open in favorite editor config.toml
base_url = "https://karzok.example.net" # set-up for production
theme = "karzok"
See more in Karzok Configuration
4. Added new content
cp ./themes/content/_index.md content/_index.md
# a template will appear with which you can quickly start writing
# cp ./themes/content/tmpl.md content/filename.md
how you can give freedom to your creativity
5. Run the project
i. development enviroment
- Install node dependencies needed to work
npm run gen # don't use npm install before that
- Just run
zola serve
in the root path of the project
zola serve
Open in favorite browser http://127.0.0.1:1111. Saved changes live reolad.
ii. production enviroment
- with docker
- Build docker image
docker build .
or if installed docker-compose
docker-compose build
- Run containers
docker start -d -p 80:80 container_id
or if installed docker-compose
docker-compose up -d
Open in favorite browser https://localhost
Configuration
options under the [extra]
math
- rendering math formulas throught katexfavicon
- set path to favicon icon import(defaultfavicon
)localcdn
- if you want to store all assets on your domain, then enable this settingcdnurl
- you can customize your url to store assets,default use jsdelivrshow_word_count
- allowing you to show number of wordsshow_reading_time
- allowing you to show reading timechildren
- for header nesting to work[[extra.menu]]
- the main navigation on the site[[extra.header]]
- the header navigantion for the site
Templates
All pages are extend to the base.html, and you can customize them as need.
License
This program is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the Apache 2.0
Contribute
Make sure to read the Code of Conduct
Find bugs and come up with features
On the todo.sr.ht or github issues
Improve Code
The Karzok is stored in the repository at sr.ht and mirror github
Thank you so much for any help