Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CodeIgniter 4 中文手册翻译项目

image All Contributors

翻译准则

中文翻译请遵守 中文文案排版指北文档翻译指南

文档翻译进度

预览最新文档

安装步骤

CodeIgniter 的用户指南使用 Sphinx 软件进行管理,并可以生成各种不同的格式。所有页面都采用 ReStructured Text 格式书写,这种格式非常方便人们阅读。

安装条件

Sphinx 软件依赖于 Python,如果你使用的是 OS X 系统,则系统已经自带 Python 了。 你可以在终端中执行不带参数的 python 命令,以确认你的系统是否已安装 Python 。 如果你已安装,会显示出你当前所使用的版本。 如果显示的不是 3.7 以上版本,你可以去这里下载并安装 3.7.6 https://www.python.org/downloads/release/python-376/

安装

  1. 安装 easy_install
  2. easy_install "sphinx==1.8.5"
  3. easy_install "sphinxcontrib-phpdomain==0.7.0"
  4. easy_install "docutils==0.16"
  5. easy_install "sphinx-rtd-theme>=0.4.3"
  6. easy_install "jieba==0.42.1"
  7. make html

译注:

  1. Ubuntu 系统上安装 easy_install 可以直接:sudo apt-get install python-setuptools
  2. easy_install 需要 root 权限,前面加上 sudo

使用 Docker

如果你喜欢使用 Docker 构建文档的话,可以这样:

  1. clone 代码库到本地,例如 /my/ci4 目录
  2. /my/ci4 目录下执行 docker build -t ci4 .
  3. /my/ci4 目录下执行 docker run -t --rm -v /my/ci4:/ci ci4

执行完毕后,/my/ci4/build/html 目录就是生成的文档啦。

编辑并创建文档

所有的源文件都在 source/ 目录下,在这里你可以添加新的文档或修改已有的文档。

那么,HTML 文档在哪里

很显然,HTML 文档才是我们最关心的,因为这毕竟才是用户最终看到的。 由于对自动生成的文件进行版本控制没有意义,所以它们并不在版本控制之下。 你如果想要预览 HTML 文档,你可以重新生成它们。生成 HTML 文档非常简单, 首先进入你的用户指南目录,然后执行上面安装步骤中的最后一步:

make html

你将会看到正在编译中的信息,编译成功后,生成的用户指南和图片都位于 build/html/ 目录下。 在 HTML 第一次编译之后,后面将只会针对修改的文件进行重编译,这将大大的节约我们的时间。 如果你想再重新全部编译一次,只需删除 build 目录然后编译即可。

贡献者

感谢这些可爱的童鞋为中文手册做出的卓越贡献。 (emoji key):


Alexander.Fu

🌍

wazidw

🌍 📆 👀

zhangxiaoshua

🌍

xin zhao

🌍

icicle198514

🌍

Calcifer

🌍

DuXuanXuan

🌍

amberhu

🌍

te-riper

🌍

tlingYX

🌍

John Wu

🌍

FirstPunch

🌍

chengshao2014

🌍

Ryan Wu

🌍

lsc77

🌍

LockeMGT

🌍

Li Wang

🌍

小叮当的肚兜

🌍

arcsinw

🌍

Qnurye

🌍

JerryGai

🌍

Hex

🌍 🚧 📆 👀

24Kdabaiyang

🌍

tianpanhaha

🌍

visvoy

🌍

张叶

🌍

binhaiit

🌍

Kang Jing

🌍

honwooh

🌍

本项目遵循 all-contributors 规范。欢迎任何形式的贡献!