diff --git a/content/changelog.md b/content/changelog.md deleted file mode 100644 index b27d5d5..0000000 --- a/content/changelog.md +++ /dev/null @@ -1,109 +0,0 @@ -+++ -title = "Changelog" -weight = 4 -+++ - -# [0.2.2] - -## New features -- new parameter `item.alt` text for your svg icon in header, if it is not specified, then the link to the resource is used as it - -## Fix - -- adding aria labels, where they were not -- provide zola description by meta tag in html - -## Maintenance -- change h3 to span in toc -- change license at the MIT - -# [0.2.1] - -## New features - -- added the ability to tear down the sidebar menu - -## Maintenance - -- switch from sr.ht builds to github workflows -- setup staging domain -- README.md remove deprecated parameter and karzok configuration adding link -- Rename src to layout folder, and started common styles into individual components. - - -# [0.2.0] - -## New features - -- mobile version is made in early version -- alpha search -- new settings `relative_path` which prints in full page -- new parameter `config.extra.theme_color` which allow tab coloring in safari -- experimental settings `header.container` activate by `devmode` -- new Dockerfile -- setup postcss and swc to compiling - -## Bug fixing - -- fixed favicons -- fixing toc and sidebar overflow -- fixing article.css large list -- correct minutes word -- fix bug with typo - - -## Maintenance - -- improved normalize.css by @sindresorhus -- separate header parameter to `header_right` and `header_left` -- README.md set link center and add design with penpot -- remove static folder, by it generation -- .build.yml new steps added for compile and optimize css code -- split the css files and reduced the size of the loaded content -- redesigned menu -- replaces font with inter -- write components a bem methology -- globally set img width -- separate macros file - -# [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/content/configure.md b/content/configure.md deleted file mode 100644 index 6ef3624..0000000 --- a/content/configure.md +++ /dev/null @@ -1,24 +0,0 @@ -+++ -title = "Configure" -weight = 2 -+++ - -## Options under the `[extra]` - -1. `math` - rendering math formulas throught [katex](https://katex.org) -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. `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 -9. `[[extra.header_right]]`,`[[extra.header_left]]` - the header navigantion for the site -10. `theme_color` which allow tab coloring in safari -11. `relative_path` which prints in full url on the page -12. `devmode` activate experimental features - -## Templates - -All pages are extend to the base.html, and you can customize them as need. diff --git a/content/contribute.md b/content/contribute.md deleted file mode 100644 index 9a9a6c1..0000000 --- a/content/contribute.md +++ /dev/null @@ -1,17 +0,0 @@ -+++ -title = "Contribute" -weight = 2 -+++ - -Make sure to read the [Code of Conduct](/meta/code-of-conduct) - -# Find bugs and come up with features - -On the [todo.sr.ht](https://todo.sr.ht/~kogeletey/karzok) or -[github issues](https://github.com/kogeletey/karzok/issues) - -# 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) diff --git a/content/install.md b/content/install.md deleted file mode 100644 index 611d39b..0000000 --- a/content/install.md +++ /dev/null @@ -1,120 +0,0 @@ -+++ -title = "Install" -weight = 1 -+++ - -# Dependencies - -1. [Zola](https://www.getzola.org/documentation/getting-started/installation/) -2. [Node.js](https://nodejs.org/) -3. [rsync](https://rsync.samba.org/) - -install for your platform. - -## Optional - -- [docker](https://docs.docker.com/engine/install/) - > for packaging container - > A better copy and move - -# Get Started - -## 1. Create a new zola site - -```zsh -zola init zola_site -``` - -## 2. Download this theme to you themes directory: - -```zsh -git clone https://git.sr.ht/~kogeletey/karzok zola_site/theme -``` - -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://git.sr.ht/~kogeletey/karzok zola_site/themes -``` - -## 3. Configuration. Open in favorite editor `config.toml` - -```toml -base_url = "https://karzok.example.net" # set-up for production -theme = "karzok" -``` - -See more in [Karzok Configuration](/configure) - -## 4. Added new content - -```zsh - 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 - -1. Install node dependencies needed to work - -```zsh -npm ci -npm run gen -``` - -2. Just run `zola serve` in the root path of the project - -```zsh -zola serve -``` - -Open in favorite browser [http://127.0.0.1:1111](http://127.0.0.1:1111). Saved -changes live reolad. - -ii. production enviroment - -- with docker - -1. Write file for container - -```Dockerfile -FROM ghcr.io/kogeletey/karzok:latest AS build-stage -# or your path to image -ADD . /www -WORKDIR /www -RUN sh /www/build.sh - -FROM nginx:stable-alpine - -COPY --from=build-stage /www/public /usr/share/nginx/html - -EXPOSE 80 -``` - -2. Run the your container -```zsh -docker build -t . &&\ -docker run -d -p 8080:8080 -``` -- using gitlab-ci and gitlab-pages - -```yml -image: ghcr.io/kogeletey/karzok:latest # or change use your registry - -pages: - script: - - sh /www/build.sh - - mv /www/public public - artifacts: - paths: - - public/ -``` - -Open in favorite browser [https://localhost:8080](http://localhost:8080) diff --git a/content/reference/code_of_conduct.md b/content/reference/code_of_conduct.md deleted file mode 100644 index 7668873..0000000 --- a/content/reference/code_of_conduct.md +++ /dev/null @@ -1,82 +0,0 @@ -+++ -title = "Code of Conduct" -date = "2019-03-11" -weight = 1 -+++ - -# Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to make participation in our project and our -community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and -expression, level of experience, education, socio-economic status, nationality, -personal appearance, race, religion, or sexual identity and orientation. - -# Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or - advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic - address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a - professional setting - -# Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, or to ban temporarily or permanently any -contributor for other behaviors that they deem inappropriate, threatening, -offensive, or harmful. - -# Scope - -This Code of Conduct applies within all project spaces, and it also applies when -an individual is representing the project or its community in public spaces. -Examples of representing a project or community include using an official -project e-mail address, posting via an official social media account, or acting -as an appointed representative at an online or offline event. Representation of -a project may be further defined and clarified by project maintainers. - -# Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at [INSERT EMAIL ADDRESS]. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an -incident. Further details of specific enforcement policies may be posted -separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -# Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 1.4, available at -https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/theme.toml b/theme.toml index 10e8bf9..fced24a 100755 --- a/theme.toml +++ b/theme.toml @@ -1,9 +1,9 @@ name = "karzok" -description = "A theme for your documentation. Fast and secure" +description = "The theme for launching fast documentation sites" license = "MIT" homepage = "https://github.com/kogeletey/karzok" min_version = "0.15.0" -demo = "https://fmatch.org/karzok" +demo = "https://karzok.re128.org" [extra] show_word_count = true