Skip to content

Latest commit

 

History

History
18 lines (10 loc) · 1.22 KB

README.md

File metadata and controls

18 lines (10 loc) · 1.22 KB

AtlasOS Documentation

Atlas documentation hosted on Cloudflare Pages using Material for MkDocs.

Here you can help Atlas with documentation, for now we do not have translation capabilities but they will be added in the future.

Want to contribute? Please check out our Documentation Contribution Guidelines and the Atlas Contribution Guidelines for more information.

How to make a preview build?

As MkDocs uses Python, you will need to have Python and pip installed, we recommend using Scoop or Chocolatey to install these but you can also install via Python's website.

Material for MkDocs has already made a page, which you can use for Installation of Material for MkDocs.

Depending if you installed it locally or via a virtual envioronment, there is already a guide on previewing

Credit