本网站的目的是方便系统级软件方面的知识共享。由武汉大学comsoft课题组主要维护。欢迎加入贡献，欢迎git clone。

加入贡献：

  1. 申请一个github账号，提醒项目管理员（请联系：qingan@whu.edu.cn），将该账号添加到该项目。

  2. git clone https://github.com/comsoftWHU/comsoftwhu.github.io.git

  3. 添加或修改.md文件，git add加入本地库。
    • 如果需要新增子目录dir，来存放dir/filename.md，则需要在新目录dir下额外添加一个index.md文件，作为该子目录的首页。

      • mkdir dir && cd dir

      • touch filename.md && touch index.md

    • 如果需要x.md文件需要引用图片，则在同目录下增加一个x.assets子目录，专门用来存放对应的图片。
    • 为了加快网页加载速度，如非必要，建议不要使用高分辨率图片（比如：QQ截图软件，可以设置为低分辨率）。
    • 文件名/文件夹名中不要用中文，否则不同系统环境下，路径操作比较麻烦。
  4. 在本地部署测试，利用本地浏览器预览web。

    • bundle install && bundle exec jekyll serve

    • 通过 http://localhost:4000/ 查看本地测试结果
    • 更多参考 https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
  5. 如果测试通过

    • git commit： 提交到本地库

    • git push：提交到远程github库（提交后，会自动部署到https://comsoftwhu.github.io/提供静态web服务）。

说明：

  1. 当前有如下子目录，请将文档组织到相关目录。
    • cs-startup：CS系统领域的入门资料。
    • 编译：编译相关的入门资料。
    • AI编译：AI编译项目相关资料，包括AI优化概念、TVM框架等。
    • Linux内核：Linux内核相关资料。
    • AOSP：Android的开源实现AOSP项目相关资料。
    • FH-compile：全同态加密编译。
  2. 文档组织以markdown提交为主，会被自动渲染成html并部署到https://comsoftwhu.github.io/comsoftWHU/；markdown文件中的图片，可以保存到一个文件夹一并push（参考compile/gc.mk, compile/gc.assets/)。
  3. markdown文件的编写，可参考已有文件，或参考https://just-the-docs.github.io/just-the-docs/。
  4. 文件名/文件夹名中不要用中文，否则路径操作比较麻烦。

以下忽略：

This is a bare-minimum template to create a Jekyll site that uses the Just the Docs theme. You can easily set the created site to be published on GitHub Pages – the README file explains how to do that, along with other details.

If Jekyll is installed on your computer, you can also build and preview the created site locally. This lets you test changes before committing them, and avoids waiting for GitHub Pages.1 And you will be able to deploy your local build to a different platform than GitHub Pages.

More specifically, the created site:

  • uses a gem-based approach, i.e. uses a Gemfile and loads the just-the-docs gem
  • uses the GitHub Pages / Actions workflow to build and publish the site on GitHub Pages

Other than that, you’re free to customize sites that you create with this template, however you like. You can easily change the versions of just-the-docs and Jekyll it uses, as well as adding further plugins.

Browse our documentation to learn more about how to use this theme.

To get started with creating a site, just click “use this template”!

If you want to maintain your docs in the docs directory of an existing project repo, see Hosting your docs from an existing project repo in the template README.

  1. It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub. ↩