Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codeigniter-chinese/codeigniter4-user-guide

CodeIgniter 4 Chinese User Guide - CodeIgniter 4 简体中文手册
https://github.com/codeigniter-chinese/codeigniter4-user-guide

codeigniter guidebook

Last synced: 25 days ago
JSON representation

CodeIgniter 4 Chinese User Guide - CodeIgniter 4 简体中文手册

Host: GitHub
URL: https://github.com/codeigniter-chinese/codeigniter4-user-guide
Owner: CodeIgniter-Chinese
Created: 2017-08-29T03:17:40.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-02-04T03:14:02.000Z (12 months ago)
Last Synced: 2024-03-26T21:22:10.790Z (10 months ago)
Topics: codeigniter, guidebook
Language: PHP
Homepage: https://codeigniter-chinese.github.io/codeigniter4-user-guide/
Size: 472 MB
Stars: 78
Watchers: 18
Forks: 62
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# CodeIgniter 4 中文手册翻译项目

[![Build Docs](https://github.com/CodeIgniter-Chinese/codeigniter4-user-guide/actions/workflows/build.yml/badge.svg)](https://github.com/CodeIgniter-Chinese/codeigniter4-user-guide/actions/workflows/build.yml)
[![All Contributors](https://img.shields.io/badge/all_contributors-29-orange.svg?style=flat-square)](#contributors-)

## 翻译准则

中文翻译请遵守
[中文文案排版指北](http://mazhuang.org/wiki/chinese-copywriting-guidelines/)
和 [文档翻译指南](translation-guide.md)

[预览最新文档](https://codeigniter-chinese.github.io/codeigniter4-user-guide/)

## 安装步骤

CodeIgniter 的用户指南使用 Sphinx 软件进行管理，并可以生成各种不同的格式。所有页面都采用 [ReStructured Text](https://en.wikipedia.org/wiki/ReStructuredText) 格式书写，这种格式非常方便人们阅读。

### 安装条件

#### Python

Sphinx 需要 Python 3.5+ 版本，如果你正在运行 macOS 或 Linux，则可能已经安装了它。
你可以在终端窗口中执行 `python` 或 `python3` 来确认。

```bash
python --version
Python 2.7.17

python3 --version
Python 3.6.9

# 对于使用 Python 启动器的 Windows
py -3 --version
Python 3.8.1
```

如果你的版本低于 3.5+，请从 [Python.org](https://www.python.org/downloads/) 安装最新的 3.x 版本。Linux 用户应该使用操作系统自带的包管理器来更新。

#### pip

现在你已经安装并运行了 Python 3.x，我们将安装 [pip](https://pip.pypa.io/en/stable/) (Python 包安装程序)。

你可以使用 `pip` 或 `pip3` 检查是否已安装 pip。如你所见，pip 遵循与 Python 相同的命名约定。请注意，输出的末尾应该显示 `python 3.x`。

```bash
pip --version
pip 9.0.1 from /usr/lib/python2.7/dist-packages (python 2.7)

pip3 --version
pip 9.0.1 from /usr/lib/python3/dist-packages (python 3.6)

# 对于使用 Python 启动器的 Windows
py -3 -m pip --version
pip 20.0.2 from C:\Users\\AppData\Local\Programs\Python\Python38\lib\site-packages\pip (python 3.8)
```

##### Linux

[使用 Linux 包管理器安装 pip/setuptools/wheel](https://packaging.python.org/guides/installing-using-linux-tools/)

##### 其他

如果你使用从 [Python.org](https://www.python.org/downloads/) 下载的 Python 3.5+，则 pip 已经安装好了。

### 安装

现在我们需要安装 Sphinx 和它的依赖项。根据操作系统选择 `pip` 或 `pip3`。
此步骤之后，你需要重启终端窗口，否则 Python 将找不到我们刚刚安装的所有应用程序。

```bash
pip install -r requirements.txt

pip3 install -r requirements.txt

# 对于使用 Python 启动器的 Windows
py -3 -m pip install -r requirements.txt
```

是时候总结一下并生成文档了。

```bash
make html
```

### 使用 Docker