Fries Docs

Unofficial documents for szu students. You can regard it as a manual in shenzhen university.

Install

Step1

clone this repo

mkdir demo
cd ./demo
git clone https://github.com/team0ne1/fries-docs.git

Step2

Fries Docs built by mkdocs-material, so you need to install it.

git clone https://github.com/squidfunk/mkdocs-material.git
pip install -r mkdocs-material/requirements.txt

You can also see the guidence in https://squidfunk.github.io/mkdocs-material/getting-started/#with-git

Usage

Build the site

Entry the directory fries-docs

cd fries-docs

Run

mkdocs build

Then, directory named site is changed.

Copy the dir images to dir site and everything is done.

Run the site

Put the dir site on your server

License

MIT © Team One