Docs
Atlas documentation hosted on Cloudflare Pages using MkDocs
Overview
The AtlasOS Documentation repository contains the Atlas documentation hosted on Cloudflare Pages using Material for MkDocs. This platform invites contributions and provides guidelines for potential contributors to follow. The documentation is powered by Python, and users are required to install Python and pip before making contributions.
Features
- Cloudflare Pages Hosting: The documentation is hosted on Cloudflare Pages for easy access.
- Material for MkDocs: Utilizes Material theme for MkDocs to provide a visually appealing documentation.
- Contribution Guidelines: Offers detailed guidelines for users interested in contributing to the documentation.
- Dependency Installation: Provides a clear guide on installing necessary dependencies for contribution.
- Preview Hosting Script: Includes a script for preview hosting on Windows for convenience.
- Live Preview: Users can view their changes live while making adjustments to the documentation.
- Themed Documentation: Acknowledges Hummingbot documentation for some theming aspects like the blurred header.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
