nkdacs / nkdacs-website

NKDACS官方网站

NKDACS-Website

欢迎来访NKDACS！

NKDACS-Website的全部内容均已开源，欢迎各位向本Repo贡献代码！

网站结构

此站点为静态站点，通过MkDocs对Markdown文件进行渲染生成静态的html文件，直接用于访问。

基于以下工具

• MkDocs：快速，简单，美观的静态站点生成器
• Markdown：简洁，强大的轻量级标记语言
• MathJax：一个跨浏览器的JavaScript库，用于支持$\LaTeX$

网站特点

• Material Design：一种特殊的现代化设计语言，能够使网站组件更有质感。在此，特别感谢开源项目MkDocs-Material，本站点采用了这一主题设计，并作了少量修改，使得网站能够显示得更加美观。
• 丰富的Markdown支持：采用了开源项目pymdown-extensions，网站的Markdown支持度得到了非常大的提升。
• 全站HTTPS：网站全站支持HTTPS，用户的访问流量得到了加密保护，可防止他人窥探或篡改网站浏览数据。

为什么采用MkDocs？

网站设计初期，我们的考虑是使用传统的Django或者Flask框架来制作这一网站，但经过小组成员的反复探讨，认为NKDACS-Website的实际设计和使用需求并不太适合用前两者来完成，而轻量、易用的MkDocs成为了我们最终的选择，主要的原因有下：

• 作为一个知识共享平台，NKDACS-Website应该是一个有严格逻辑框架的网站，将会有着广而深的框架式学术内容，传统的博客框架更多地基于时间顺序结构，以及简单的分类和标签结构，而MkDocs作为Wiki化的文档管理系统，与本网站的需求一拍而合。
• 上手简单、易维护。NKDACS是一个学生团体，而学生的学籍变动快，一旦负责网站设计、维护的同学毕业离校，将会存在网站交接的难题，MkDocs上手简单、设计规范、无需进行服务器维护，对比传统的Django/Flask框架，更适合学生团队持续运营。

如何在本地模拟运行本网站？

1. 在终端界面逐步运行如下命令（需要安装 python, git 等）

git clone https://github.com/NKDACS/NKDACS-Website/
cd NKDACS-Website/
pip install -r requirements.txt
mkdocs serve

2. 本地浏览器访问 http://127.0.0.1:8000/ ，查看网站效果。

如何指出NKDACS-Website上的错误，以及如何在这个平台上分享知识？

我们已将网站的全部文章的Markdown源码开源于此Repo的docs文件夹内，而网站的所有页面均直接基于这些Markdown文件进行渲染生成，因此，您只需要修改相应的文件然后提交Pull Request，我们会根据采用情况进行Merge，或者您也可以针对具体的情况在Repo内提出Issues，我们会做出相应的回应。

具体如何参与公共编辑？

如何修改已有文章

在每篇文章的右上角，点击笔形状的编辑按钮，登录Github账号后，将能直接对Markdown源码进行编辑。

编辑完成后，请点击最下方的绿色按钮，最后确认提交，你也可以在下方的方框中补充说明一下修改理由，我们收到后会根据采用情况来决定是否Merge。

如何投稿

如果想要向我们投稿，请进入Github页面内的docs文件夹，选择一个你想投稿的目录对应的文件夹，进入文件夹后，点击右上角的"Create new file"，随后便能开始撰写你的内容，最后同上面的操作步骤一样，发起Pull Request后，将由我们决定是否采用。

注意：请务必在文章中署名，若您是授权将您个人网站中的文章转载在本站，也请一并在文中附上原文地址。当您发起投稿后，将意味着同意本站所使用的"CC BY-NC-ND 4.0"知识共享协议，投稿前请先阅读协议条款，确定您是否接受这一协议。同时，您随时可以向我们申请撤销刊登文章的授权，只需要在Repo中申请删除对应文件的Pull Request即可。