https://github.com/capjamesg/aurora-docs-template

A documentation template built with Aurora.
https://github.com/capjamesg/aurora-docs-template

aurora documentation-site static-site static-site-template

Last synced: 3 months ago
JSON representation

A documentation template built with Aurora.

• Host: GitHub
• URL: https://github.com/capjamesg/aurora-docs-template
• Owner: capjamesg
• Created: 2024-06-18T12:22:40.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-06-22T17:40:18.000Z (11 months ago)
• Last Synced: 2025-02-14T03:18:31.214Z (3 months ago)
• Topics: aurora, documentation-site, static-site, static-site-template
• Language: CSS
• Homepage: https://aurora.jamesg.blog/
• Size: 45.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Documentation Template

A documentation template built in Aurora, based on the [Aurora documentation](https://aurora.jamesg.blog.).

![A documentation homepage with a sidebar](screenshot.png)

## How to Use

First, install Aurora:

```

pip install aurora-ssg

```

Then, run:

```

git clone https://github.com/capjamesg/aurora-docs-template

cd aurora-docs-template

```

To start developing the site, run:

```

aurora serve

```

When you are ready to generate a version of your site for publishing, update the `production` base URL in the `config.py` file, then run:

```

aurora build

```

This will generate a static version of your site in the `_site` directory, ready for use.

## License

This project is licensed under a Creative Commons Zero license.