Skip to content

Latest commit

 

History

History
138 lines (95 loc) · 3.17 KB

README.md

File metadata and controls

138 lines (95 loc) · 3.17 KB
Raw

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
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 codeberg issues or github issues