https://github.com/atlas-os/docs

Atlas documentation hosted on Cloudflare Pages using MkDocs
https://github.com/atlas-os/docs

atlasos docs documentation mkdocs open-source wiki

Last synced: 30 days ago
JSON representation

Atlas documentation hosted on Cloudflare Pages using MkDocs

• Host: GitHub
• URL: https://github.com/atlas-os/docs
• Owner: Atlas-OS
• License: cc-by-sa-4.0
• Created: 2022-08-12T04:48:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-13T07:35:31.000Z (about 1 month ago)
• Last Synced: 2024-10-14T07:43:16.657Z (30 days ago)
• Topics: atlasos, docs, documentation, mkdocs, open-source, wiki
• Language: HTML
• Homepage: https://docs.atlasos.net
• Size: 143 MB
• Stars: 138
• Watchers: 8
• Forks: 53
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing/contribution-guidelines.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# 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](https://docs.atlasos.net/contributions) for more information.

## How do I contribute?

As MkDocs Material uses Python, you must install [Python](https://www.python.org/downloads/) alongside `pip` before continuing.

1. Once you've cloned the repository, `cd` into it using a shell

1. Run `pip install -r requirements.txt` to install all the dependencies

1. 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!

## Credits

- [Hummingbot documentation](https://github.com/hummingbot/hummingbot) for many aspects of the documentation theming, such as the blurred header

## 💙 Contributors