https://github.com/johnnovak/gridmonger-site

https://github.com/johnnovak/gridmonger-site

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/johnnovak/gridmonger-site
• Owner: johnnovak
• License: wtfpl
• Created: 2020-12-29T10:12:53.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-11-03T07:51:04.000Z (almost 3 years ago)
• Last Synced: 2025-01-30T07:30:01.074Z (9 months ago)
• Language: HTML
• Size: 39.7 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

          
# Gridmonger site & manual

This repo contains both the documentation sources and the GitHub Pages site

for the [Gridmonger](https://github.com/johnnovak/gridmonger) project.

The GitHub Pages site is built from the `/docs` folder in the `master`

branch. 

The generated site can be viewed at https://gridmonger.johnnovak.net, and the

actual user manual is [here](https://gridmonger.johnnovak.net/manual/contents.html).

## Requirements

- [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) 5.3+

- [Sass](https://sass-lang.com/) 1.37+

- [Make](https://www.gnu.org/software/make/) 3.8+

- [GNU sed](https://www.gnu.org/software/sed/) 4.8+

- Zip 3.0+

## Building

- To build the site & manual, run `make gen_html`.

- To create the zipped distribution package of the manual from the generated

  files, run `make dist_html`.

- There are a few other make commands available to aid theme development

  (`watch_docs_css` and `watch_frontpage_css`).

## License

Developed by John Novak <>, 2020-2022

This work is free. You can redistribute it and/or modify it under the terms of

the [Do What The Fuck You Want To Public License, Version 2](http://www.wtfpl.net), as published

by Sam Hocevar. See the [COPYING](./COPYING) file for more details.