51 lines (32 loc) · 1.36 KB

Go Advanced Admin - Documentation

This repository contains the documentation for the Go Advanced Admin Panel.

The documentation is now built with MkDocs and the Material for MkDocs theme, and is hosted at goadmin.dev.

Contributing to the Documentation

We welcome contributions to improve the documentation! If you'd like to contribute:

Clone this repository.
Make your changes or additions.
Submit a pull request for review.

Please ensure that your contributions align with the project's style and guidelines.

Building the Documentation Locally

To work on the documentation locally:

Ensure you have a recent version of Python installed.
Install the required dependencies:
```
pip install mkdocs-material
```
Start the live preview server:
```
mkdocs serve
```
The site will be available at http://127.0.0.1:8000. MkDocs rebuilds the site whenever you save changes.
To produce a static build:
```
mkdocs build
```
The generated site will be written to the site/ directory (ignored by Git).

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.