# icec_wiki

**Repository Path**: cuit_icec/icec_wiki

## Basic Information

- **Project Name**: icec_wiki
- **Description**: Github 的镜像仓库。
- **Primary Language**: Unknown
- **License**: CC-BY-SA-4.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-03
- **Last Updated**: 2022-03-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CUIT ICEC Wiki

[![GitHub forks](https://img.shields.io/github/forks/cuit-icec/cuit-icec.github.io)](https://github.com/cuit-icec/cuit-icec.github.io/network)
[![GitHub stars](https://img.shields.io/github/stars/cuit-icec/cuit-icec.github.io)](https://github.com/cuit-icec/cuit-icec.github.io/stargazers)
[![GitHub Actions](https://github.com/cuit-icec/cuit-icec.github.io/workflows/GitHub%20Pages/badge.svg)](https://github.com/cuit-icec/cuit-icec.github.io/actions)

## 写在开头 :tada:

欢迎参与到电协wiki的编辑中来，每个人的付出都能为电协的知识体系贡献一份力~

## URL :link:

[CUIT ICEC Wiki - CUIT ICEC Wiki (gitee.io)](https://cuit_icec.gitee.io/icec_wiki/)

## 起步 :rocket:

运行环境：python 3.6+

```sh
# 配置运行环境，推荐使用 virtualenv
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
# 启动本地服务器，可在修改文章的同时实时查看渲染效果，服务器会自动重载
mkdocs serve
```

运行之后命令行会输出**本地的预览链接**，这样提交之前可以**验证**一下有没有一些**格式错误**

![image-20210202225548628](https://gitee.com/zhongyichen33/testtupian/raw/master/20210202225548.png)

### 可能出现的问题 :question:

1.如果安装出现以下提示，需要将对应的script文件夹路径加入环境变量中

```
 WARNING: The script pygmentize.exe is installed in 'C:\Users\Administrator.VZMRW9ETL45BX39\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\Scripts' which is not on PATH.
```

## 新增文章 :pencil:

将要添加至 Wiki 的 Markdown 文件保存至 `docs` 下的文件夹中，然后修改 `mkdocs.yml` 中的 `nav` 属性，将文章的标题及路径添加至 Wiki 目录，如：

```ymal
nav:
  - 简介:
    - 首页: index.md
    - 关于: about.md
  - 硬件:
    - 电路分析: hardware/circuit_analysis.md
  - 软件:
    - C 语言: software/c_language.md
```

## 编写文章

这里我们跳转到工具来具体说下

## 最后

通过本地预览链接确认没有问题后，提交到服务器，服务器会进行内容的自动构建和部署