codingdojoorg/codingdojo.org

CodingDojo.org镜像说明

!https://img.shields.io/docker/build/codingdojoorg/codingdojo.org.svg

镜像概述

该镜像对应CodingDojo.org网站的Hugo静态站点构建版本，包含网站内容及本地开发工具，支持用户贡献和维护网站内容。

核心功能

1. 支持本地Hugo或Docker环境运行网站，实现实时预览
2. 提供内容贡献指南，包括添加新页面、翻译内容等
3. 支持自定义内容摘要设置
4. 允许用户通过Pull Request提交修改，参与网站维护

使用场景

• 开发人员贡献CodingDojo.org网站内容（如添加Dojo会话、Kata等）
• 本地预览网站修改效果，确保内容正确显示

配置说明

贡献前准备

1. Fork以下仓库：
   • https://github.com/codingdojo-org/codingdojo.org
   • https://github.com/codingdojo-org/template-hugo-codingdojo
2. 克隆你的fork仓库及主题：

   bash
   git clone git@github.com:_你的账户_/codingdojo.org.git
   cd codingdojo.org
   git clone git@github.com:_你的账户_/template-hugo-codingdojo themes/template-hugo-codingdojo
   

本地Hugo运行

注意：当前Hugo 0.34版本可能存在布局问题，建议使用镜像中的0.26版本：

bash
# 启动本地服务并实时重载
make hugo

打开浏览器访问http://localhost:1313即可预览。

Docker环境运行

确保已安装Docker，执行以下命令：

bash
make docker-dev
make hugo

打开浏览器访问http://localhost:1313预览。

添加新页面

创建Markdown文件并添加以下前置内容：

markdown
---
title: "页面标题"
date: "YYYY-MM-DD"
---

提交Pull Request即可。

• 添加Dojo会话：放在content/dojo/目录
• 添加Kata：放在content/kata/目录

翻译内容

翻译页面需命名为原页面名.LANG.md，例如FizzBuzz kata的法语翻译为FizzBuzz.fr.md。

特殊说明

摘要设置

默认取内容前70个单词作为摘要，若需自定义，在内容中添加：

markdown
<!--more-->

（无空格，用于标记摘要结束位置）

人员页面移除

若需移除旧页面（如个人页面），可通过提交Issue或Pull Request申请。