AtlasOS Documentation

This repository contains the Atlas documentation hosted on Cloudflare Pages using Material for MkDocs.

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

How do I contribute?

As MkDocs Material uses Python, you must install Python alongside pip before continuing.

Once you've cloned the repository, cd into it using a shell
Run pip install -r requirements.txt to install all the dependencies
If you're on Windows, run locally-host.cmd to host the documentation preview
- If you're on another OS, just run mkdocs serve
- The locally-host.cmd script is only for convenience

You can now make all your changes and view them live!

Hummingbot documentation for many aspects of the documentation theming, such as the blurred header

Name		Name	Last commit message	Last commit date
Latest commit History 919 Commits
.github		.github
.vscode		.vscode
docs		docs
includes		includes
overrides		overrides
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
base-requirements.txt		base-requirements.txt
jampack.config.mjs		jampack.config.mjs
local-requirements.txt		local-requirements.txt
locally-host.cmd		locally-host.cmd
mkdocs.insiders.yml		mkdocs.insiders.yml
mkdocs.yml		mkdocs.yml
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
requirements.txt		requirements.txt