https://github.com/nmwsharp/geometry-central-docs
Hosted documentation for geometry-central
https://github.com/nmwsharp/geometry-central-docs
Last synced: over 1 year ago
JSON representation
Hosted documentation for geometry-central
- Host: GitHub
- URL: https://github.com/nmwsharp/geometry-central-docs
- Owner: nmwsharp
- Created: 2019-07-06T03:41:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T01:47:48.000Z (almost 2 years ago)
- Last Synced: 2025-01-19T07:43:44.957Z (over 1 year ago)
- Language: Shell
- Size: 28.7 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# geometry-central-docs
Hosted documentation for geometry-central.
The actual documentation content lives in the geometry-central repo, in the /docs subdirectory. This repo exists soley to host the github pages page, and pulls from that repo as a submodule.
To install mkdocs and theme:
```
pip install mkdocs mkdocs-material pygments
```
To build and deploy:
`sh build_commit_push.sh`
or, manually run:
```
python3 -m mkdocs build --config-file geometry-central/docs/mkdocs.yml --site-dir ../../docs
git add docs/
git commit
git push
```
the gnomes will promptly get to work building the website, and content at geometry-central.net will update in a few minutes.