# esp-faq

**Repository Path**: espressif-systems/esp-faq

## Basic Information

- **Project Name**: esp-faq
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-12
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Espressif FAQ 文档

* [English Version](./README.md)
  
ESP-FAQ 是由乐鑫官方推出的针对常见问题的总结文档。

## 文档托管

* English: https://docs.espressif.com/projects/espressif-esp-faq/en/latest/ (待完善)
* 中文: https://docs.espressif.com/projects/espressif-esp-faq/zh_CN/latest/

## ESP-FAQ 文档框架

### 语言支持

* 文档框架支持 reStructuredText 和 Markdown 轻量标记语言。

### 文档结构

``` bash
docs
├── _static
│   ├── espressif-logo.svg       # 网页 log
│   └── theme_overrides.css      # 网页样式表
├── zh_CN
│   ├── _static                  # 内联资源
│   ├── get-started              # 入门指南
│   ├── development-environment  # 开发环境
│   ├── application-solution     # 应用方案
│   ├── hardware-related         # 硬件相关
│   ├── software-framework       # 软件平台
│   ├── test-verification        # 测试验证
│   ├── config.py                # sphinx 配置
│   ├── Makefile                 # 编译文件
│   └── index.rst                # 主目录
└── en
    ├── _static                  # 内联资源
    ├── get-started              # 入门指南
    ├── development-environment  # 开发环境
    ├── application-solution     # 应用方案
    ├── hardware-related         # 硬件相关
    ├── software-framework       # 软件平台
    ├── test-verification        # 测试验证
    ├── config.py                # sphinx 配置
    ├── Makefile                 # 编译文件
    └── index.rst                # 主目录
```

### 文档贡献

* 请阅读 [贡献指南](docs/zh_CN/get-started/document-contribution.md)。

## 其它参考资源

* 可以前往 [esp32.com 论坛](https://esp32.com/) 提问，挖掘社区资源。

* 如果你在使用中发现了错误或者需要新的功能，请先[查看 GitHub Issues](https://github.com/espressif/esp-faq/issues)，确保该问题不会被重复提交。

* 如果你有兴趣为 ESP-FAQ 作贡献，请先阅读[贡献指南](docs/zh_CN/get-started/document-contribution.md)。