# Documents

**Repository Path**: lightningsemi/documents

## Basic Information

- **Project Name**: Documents
- **Description**: 亮牛文档中心
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-06-07
- **Last Updated**: 2026-01-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# 亮牛半导体文档中心

## 简述

该文档中心基于 Sphinx 搭建，使用 ReadTheDocs 主题。用于内网用户基于浏览器浏览公司内部文档。

该仓库的 master 分支属于仓库的主分支，受提交保护，非管理员用户无法直接推送内容到该分支。非管理员用户在提交新的内容时，请基于 master 新建一个分支提交到仓库，并在仓库上发起 MergeRequest 请求，管理员收到合并请求并检查无误后，合并该分支到 master 分支。

## 网址

在浏览器输入以下连接即可浏览文档：

## 提交文档

> 支持基于 Markdown 格式或者 ReST 格式提交文档。

## 图片和其他文件存放位置

如有 PDF、WORD、visio 等文档需要链接的话，直接使用 markdown 超链接语法（`[超链接](./_static/xxx.pdf)`）。注意，链接的外部文档如果在本地，那么需要将文档拷贝到 `_static` 目录。

## 友情链接

- [sphinx 官网](https://www.sphinx-doc.org/en/master/)
- [sphinx 中文站点](https://www.sphinx.org.cn/index.html)