Project Mu Documentation
Перейти к файлу
Bret Barkelew e2c0941d7e Fix small spelling errors in security doc 2020-10-27 14:18:17 -07:00
docs Fix small spelling errors in security doc 2020-10-27 14:18:17 -07:00
theme/assets/images Switch to a cleaner theme. (#8) 2018-09-28 11:48:13 -07:00
.flake8 Update content for developing code and documentation (#49) 2018-12-10 23:55:02 -08:00
.gitignore Add support for pulling documentation from other Project Mu Repos (#33) 2018-10-15 10:58:40 -07:00
.markdownlint.yaml Update release notes with current process and new images (#98) 2020-10-20 21:22:23 -07:00
DocBuild.py fix new flake8 error for poor variable name 2020-08-13 11:22:03 -07:00
LICENSE Initial docs checkin 2018-09-17 13:53:10 -07:00
README.md Add markdownlint into the Doc development process and PR gates (#96) 2020-10-12 22:10:51 -07:00
Test_DocBuild.py Doc updates for 202002, PyTools, and testing (#87) 2020-03-22 16:57:44 -07:00
Utf8Test.py Doc updates for 202002, PyTools, and testing (#87) 2020-03-22 16:57:44 -07:00
azure-pipelines-pr-gate.yml Add markdownlint into the Doc development process and PR gates (#96) 2020-10-12 22:10:51 -07:00
cspell.json Add markdownlint into the Doc development process and PR gates (#96) 2020-10-12 22:10:51 -07:00
mkdocs_base.yml Merged PR 2969: Add a doc about the security patch repos 2020-10-26 23:22:29 +00:00
requirements.txt Update content for developing code and documentation (#49) 2018-12-10 23:55:02 -08:00

README.md

Project Mu

Build status

This repository contains documentation of the Project Mu.

You can find the documentation at https://microsoft.github.io/mu/.

How to build the docs

We are using MkDocs to build the documentation.

The following gives you a rough overview how to serve it locally:

  • Run pip install --upgrade -r requirements.txt
  • Run DocBuild.py --Build --Clean --yml mkdocs_base.yml
  • Run mkdocs serve

Now you should be able to open http://127.0.0.1:8000 on your machine.

A more detailed information how to build this project can be found here.