https://github.com/toltec-dev/web

Files used to build Toltec’s website.
https://github.com/toltec-dev/web

docutils website

Last synced: about 2 months ago
JSON representation

Files used to build Toltec’s website.

• Host: GitHub
• URL: https://github.com/toltec-dev/web
• Owner: toltec-dev
• License: mit
• Created: 2021-04-09T17:00:06.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-13T14:16:39.000Z (almost 2 years ago)
• Last Synced: 2024-06-13T17:13:56.911Z (almost 2 years ago)
• Topics: docutils, website
• Language: CSS
• Homepage: https://toltec-dev.org
• Size: 456 KB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Toltec Website

_Please refer to [our website](https://toltec-dev.org) for information on how to install and use Toltec._

This repository contains the files used to build [Toltec’s website](https://toltec-dev.org).

We use [Sphinx](https://www.sphinx-doc.org/en/master/) to author and build the website.

### Structure

* The overall site structure is defined in [`src/sitemap.rst`](src/sitemap.rst). This file is used to generate the sidebar.

* The global site layout is defined in [`src/_themes/toltec/layout.html`](src/_themes/toltec/layout.html). In that folder, the stylesheet and global images can be found.

* Toltec-specific Sphinx extensions are defined under [`src/_ext`](src/_ext).

### Workflows

Commits pushed to the main branch of this repository will trigger a GitHub Workflow that builds the website and deploys it to the live server.

This workflow is also triggered by pushes to the main repository’s stable branch (to automatically update the [bootstrap script](https://toltec-dev.org/bootstrap) to the latest stable version).

### Build Instructions

After cloning this repo, use `make prod` to generate the website.

The build result will be located under the `dist/` folder.

You can also use `make dev` to start a live-reloading server, which is useful to see your changes rendered in real time.