kogeletey
/
karzok
0
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity
It will help speed up the development of a website and docs for your product. Website: https://karzok.re128.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
259 Commits
4 Branches
13 Tags
1.8 MiB
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'release'
${ noResults }
Go to file
Konrad Geletey 4fe57be557
chore(fix): sidebar fix indents 		2 months ago
.github/workflows chore(format): all files 7 months ago
assets .github/workflows: remove unnecessary commands. assets: remove CNAME 9 months ago
content maintenance(format): markdown syntax fix 2 months ago
dist chore(fix): deps of dist 2 months ago
islands feat(types): starting typing typescript 2 months ago
sass chore(fix): sidebar fix indents 2 months ago
templates feat(intl): made a variable and supported multilingual support for description 2 months ago
.gitattributes .github/workflows: change repository name 10 months ago
.gitignore chore: change pre-commit to pre-push, ignore config in dist folder and remove go-specific commands 2 months ago
.stylelintrc.json chore(format,lint): configure prettier and stylelint 7 months ago
.swcrc chore(fix): change license date, adding swc shema and change code_of_conduct 2 months ago
LICENSE chore(fix): change license date, adding swc shema and change code_of_conduct 2 months ago
README.md chore(fix): change license date, adding swc shema and change code_of_conduct 2 months ago
config.toml feat(intl): made a variable and supported multilingual support for description 2 months ago
lefthook.yml maintenance(pre-push): change rules of files. 2 months ago
package.json chore(up): update swc to new version 2 months ago
pnpm-lock.yaml chore(up): update swc to new version 2 months ago
screenshot.png root: update screenshot 1 year ago
theme.toml root: theme.toml change url and description content: moved to production site https://framagit.org/kogeletey/nebra 11 months ago

README.md

github workflows status license a repository latest release as a repository pipeline status re128

Karzok

A theme for your documentation. Fast and secure

screenshot

Demo

Karzok

Requirements

Optional

for packaging container and production

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 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

  1. Install node dependencies needed to work
npm ci
npm run gen
  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 docker
  1. Write file for container
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
  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 registry

pages: 
  script:
    - sh /www/build.sh   
    - mv /www/public public
  artifacts:
    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 todo.sr.ht or github issues