From 835e375c72f1a8bbc9b04951f813c244a2d1fe57 Mon Sep 17 00:00:00 2001 From: kogeletey <kg@re128.org> Date: Tue, 14 Sep 2021 16:21:13 +0300 Subject: [PATCH] root: CHANGELOG.md created. content,root: README.md,configure,contribute,install documentation on new functions has been written --- CHANGELOG.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 11 +++++++---- content/configure.md | 5 ++++- content/contribute.md | 16 ++++++++-------- content/install.md | 4 ++-- 5 files changed, 56 insertions(+), 15 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f830488 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# [0.1.3] - 2021-09-14 + +## New features + +- settings `show_word_count` and `show_reading_time` allowing you to show the number of words and the time of reading it on the page, respectively. +- macro toc now has the opinion `config.extra.children` display all headers, nested within each other. +- added the ability to set an icon in the header. +- add possibility disable config.menu +- macros new katex contrib plugins added for rendering shortcodes + +## Bug fixing +- macro footer now automatically affixes the version, toc trying to highlight a specific header on pages +- macros fixed display, now tags are displayed correctly + +# [0.1.2] - 2021-08-28 + +## New features +- 404 template stylized +- configure the ability to store assets on another cdn. + +## Maintenance +- base.html move link to resources for convience from scss file + +## Bug fixing +- Sidebar selected in separated files and fix big sidebar error +- Fixed chevron link +- Sidebar width fixing size +- Fixed a bug that manifests itself in the sidebar +- toc fixed width layout error + + +## [0.1.0] - 2021-08-26 + +- new zola theme for your documentation, first public release under license Apache 2.0 + diff --git a/README.md b/README.md index a00d9de..e422af1 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,10 @@ Open in favorite browser [https://localhost](http://localhost) 2. `favicon` - set path to favicon icon import(default `favicon`) 3. `localcdn`- if you want to store all assets on your domain, then enable this setting 4. `cdnurl` - you can customize your url to store assets,default use [jsdelivr](https://www.jsdelivr.com) -5. `[[extra.menu]]` - the main navigation on the site +5. `show_word_count` - allowing you to show number of words +6. `show_reading_time`- allowing you to show reading time +7. `children`- for header nesting to work +8. `[[extra.menu]]` - the main navigation on the site 6. `[[extra.header]]` - the header navigantion for the site ### Templates @@ -152,7 +155,7 @@ On the [todo.sr.ht](https://todo.sr.ht/~kogeletey/karzok) or [github issues](htt ## Improve Code The Karzok is stored in the repository at [sr.ht](https://sr.ht/~kogeletey/karzok) and mirror [github](https://github.com/kogeletey/karzok) ### TODOs: -- [ ] readme contrubutions +- [x] readme contrubutions - [x] configure loading from cdn - [x] choose code_of_conduct - [x] proceed subpages @@ -160,8 +163,8 @@ The Karzok is stored in the repository at [sr.ht](https://sr.ht/~kogeletey/karzo - [x] choose license - [ ] adding full path article in the page - [ ] make dark theme -- [ ] continue author rendering -- [ ] adding word count +- [x] continue author rendering +- [x] adding word count - [x] refactor home.scss > Thank you so much for any help diff --git a/content/configure.md b/content/configure.md index b168ba3..3baec65 100644 --- a/content/configure.md +++ b/content/configure.md @@ -9,7 +9,10 @@ weight = 2 2. `favicon` - set path to favicon icon import(default `favicon`) 3. `localcdn`- if you want to store all assets on your domain, then enable this setting 4. `cdnurl` - you can customize your url to store assets -5. `[[extra.menu]]` - the main navigation on the site +5. `show_word_count` - allowing you to show number of words +6. `show_reading_time`- allowing you to show reading time +7. `children`- for header nesting to work +8. `[[extra.menu]]` - the main navigation on the site 6. `[[extra.header]]` - the header navigantion for the site ## Templates diff --git a/content/contribute.md b/content/contribute.md index 87851e7..347705c 100644 --- a/content/contribute.md +++ b/content/contribute.md @@ -12,16 +12,16 @@ The Karzok is stored in the repository at [sr.ht](https://sr.ht/~kogeletey/karzo ## TODOs -- [ ] readme contrubutions -- [x] choose code_of_conduct +- [x] readme contrubutions - [x] configure loading from cdn -- [x] Proceed subpages +- [x] choose code_of_conduct +- [x] proceed subpages - [ ] create mobile version -- [x] Choose license -- [ ] Adding full path article in the page -- [ ] Make dark theme -- [ ] Continue author rendering -- [ ] Adding word count +- [x] choose license +- [ ] adding full path article in the page +- [ ] make dark theme +- [x] continue author rendering +- [x] adding word count - [x] refactor home.scss diff --git a/content/install.md b/content/install.md index aeb26b2..ee01daf 100644 --- a/content/install.md +++ b/content/install.md @@ -29,7 +29,7 @@ zola init zola_site ## 2. Download this theme to you themes directory: ```zsh -git clone https://github.com/re128/karzok zola_site/themes +git clone https://git.sr.ht/~kogeletey/karzok zola_site/theme ``` or install as submodule: @@ -37,7 +37,7 @@ or install as submodule: ```zsh cd zola_site git init # if your project is a git repository already, ignore this command -git submodule add https://github.com/re128/karzok zola_site/themes +git submodule add https://git.sr.ht/~kogeletey/karzok zola_site/themes ``` ## 3. Configuration. Open in favorite editor `config.toml` -- GitLab