Code Monkey home page Code Monkey logo

router-lab-docs's Introduction

Router-Lab Documentation

Build documentation with mkdocs

本项目为 Router Lab 的实验文档,采用 mkdocs 编写。

本站点的自动编译版本在 这里 发布。

撰写

本站点内容使用 Markdown 进行编写。具体可查看 mkdocsmkdocs-material 文档。

如果创建了新页面,需要插入到 mkdocs.ymlnav 部分,否则将不会出现在编译结果中。

编译

首先安装依赖,而后编译即可:

python3 -m pip install --user -r requirements.txt # 安装 Python 依赖包
mkdocs serve # 直接在本地 serve,或者:
mkdocs build --clean # 生成于 site/ 文件夹中

生成离线版

生成 PDF 和 DOCX 版本需要(经过修改的) mkdocs-combine 插件的支持。首先安装插件:

pip3 install git+https://github.com/Harry-Chen/mkdocs-combine.git

而后运行:

make docx
make pdf

即可在 generated 目录下获得相应格式的文件。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.