Skip to content

Astraeus-Library/Astraeus-Library.github.io

Repository files navigation

Astraeus-Library.github.io

Organization wide repo for docs, assets, and tools any other static information.

Updating the docs

Astraeus-Library uses mkdocs-material to generate our documentation.

If you'd like to contribute to the Astraeus-Library website and documentation you can do so by first installing mkdocs-material.

pip install mkdocs-material

Then to run render and serve the documentation run

mkdocs serve

The page should be available on this address http://localhost:8000.

Now whenever you update the markdown in the mkdocs directory, the page will auto-reload with your changes. Checkout mkdocs-material for more details on the features that can be used for the site.

Contributing

See CONTRIBUTING.md for details.

License

Apache 2.0; see LICENSE for details.

Disclaimer

This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.

About

Official Astraeus documentation website

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published