karzok

用于快速搭建文档站点的主题

作者: Konrad Geletey

此主题需要 Zola 版本 0.15.0 及以上

许可证: MIT

主页: https://github.com/kogeletey/karzok

在线演示: https://karzok.re128.org

最后更新: 2024-07-18T16:03:24Z

Documentation

Karzok

• 无 class、无框架依赖
• 类 Jinja 模板风格
• JavaScript 可选，仅搜索、数学公式、提示框和深色模式需要
• 无圆角等花哨设计趋势

快速开始

• find out more

依赖要求

• Node.js

1. 创建新的 zola 站点

zola init zola_site

2. 将主题下载到 themes 目录：

git clone https://codeberg.org/kogeletey/karzok zola_site/themes

或作为子模块安装：

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. 配置：用你常用的编辑器打开 config.toml

base_url = "https://karzok.example.net" # set-up for production
theme = "karzok"

See more in configuration

4. 添加初始内容

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

之后你就可以自由发挥进行创作。

5. 运行项目

i. 开发环境

1. 安装构建所需 Node 依赖

pnpm ci
pnpm run build

2. 在项目根目录运行 zola serve

zola serve

在浏览器打开 http://127.0.0.1:1111。保存改动后会自动热重载。

ii. 生产环境

• 使用容器

1. 编写容器文件

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. 运行容器

docker build -t <your_name_image> . &&\
docker run -d -p 8080:8080 <your_name_image> 

• 使用 gitlab-ci 与 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

许可证

这是自由软件：你可以按自己的意愿使用、研究、分享和改进它。
具体来说，你可以在 MIT 条款下重新分发和/或修改它。

贡献

请先阅读 Code of Conduct。

反馈缺陷与功能建议

On the codeberg issues or github issues