0
1
Fork
You've already forked karzok
0
It will help speed up the development of a website and docs for your product. Website: https://karzok.re128.org
  • HTML 47.6%
  • SCSS 32%
  • TypeScript 20.4%
Find a file
2023年05月07日 21:48:42 +03:00
assets .github/workflows: remove unnecessary commands. assets: remove CNAME 2022年07月07日 15:19:44 +03:00
content maintenance(format): markdown syntax fix 2023年01月25日 15:57:15 +03:00
dist rename(dist): Dockerfile to Containerfile 2023年03月04日 14:54:30 +03:00
islands feat(types): starting typing typescript 2023年01月26日 15:26:52 +03:00
sass chore(fix): sidebar fix indents 2023年02月05日 11:34:43 +03:00
templates feat(intl): made a variable and supported multilingual support for description 2023年02月04日 15:46:31 +03:00
.gitattributes .github/workflows: change repository name 2022年05月13日 20:18:27 +03:00
.gitignore chore: change pre-commit to pre-push, ignore config in dist folder and remove go-specific commands 2023年01月26日 11:53:30 +03:00
.stylelintrc.json chore(format,lint): configure prettier and stylelint 2022年09月04日 16:58:27 +03:00
.swcrc chore(fix): change license date, adding swc shema and change code_of_conduct 2023年02月05日 11:33:42 +03:00
.woodpecker.yml ci: adding chmod, but not spawnsync 2023年05月07日 21:46:57 +03:00
config.toml feat(intl): made a variable and supported multilingual support for description 2023年02月04日 15:46:31 +03:00
lefthook.yml maintenance(pre-push): change rules of files. 2023年02月01日 12:57:37 +03:00
LICENSE chore(fix): change license date, adding swc shema and change code_of_conduct 2023年02月05日 11:33:42 +03:00
package.json chore(up): update packages 2023年05月07日 21:43:11 +03:00
pnpm-lock.yaml chore(up): update packages 2023年05月07日 21:43:11 +03:00
README.md doc: readme reworked, fixed links to codeberg and changed links to documentation 2023年03月07日 18:11:14 +03:00
screenshot.png root: update screenshot 2022年02月04日 16:14:04 +03:00
theme.toml root: theme.toml change url and description content: moved to production site https://framagit.org/kogeletey/nebra 2022年05月11日 18:24:51 +03:00

status-badge license a repository, MIT latest release as a repository

Documentation

Karzok

  • classless and frameworkless
  • Jinja-like templates
  • javascript is optional, needed only for search,math,alerts and dark mode
  • no roundings and other strange design trends

screenshot

Get Started

Requirements

1. Create a new zola site

zola init zola_site

2. Download this theme to you themes directory:

git clone https://codeberg.org/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://codeberg.org/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 configuration

4. Added new content

 cp ./themes/content/_index.md content/_index.md

how you can give freedom to your creativity

5. Run the project

i. development enviroment

  1. Install node dependencies needed to work
pnpm ci
pnpm run build
  1. 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 conainers
  1. Write file for container
FROMghcr.io/kogeletey/karzok:latestASbuild-stage# or your path to imageADD . /wwwWORKDIR/wwwRUN sh /www/build.sh FROMnginx:stable-alpineCOPY --from=build-stage /www/public /usr/share/nginx/htmlEXPOSE80
  1. Run the your container
docker build -t <your_name_image> . &&\
docker run -d -p 8080:8080 <your_name_image>
  • using gitlab-ci and gitlab-pages
image:ghcr.io/kogeletey/karzok:latest# or change use your registrypages:script:- sh /www/build.sh - mv /www/public publicartifacts:paths:- public/

Open in favorite browser https://localhost:8080

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 MIT

Contribute

Make sure to read the Code of Conduct

Find bugs and come up with features

On the codeberg issues or github issues