https://github.com/stuypulse/pulsedocs
Holds documentation and references for StuyPulse's SE Division
https://github.com/stuypulse/pulsedocs
Last synced: 5 months ago
JSON representation
Holds documentation and references for StuyPulse's SE Division
- Host: GitHub
- URL: https://github.com/stuypulse/pulsedocs
- Owner: StuyPulse
- License: mit
- Created: 2017-09-20T21:49:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-07-19T05:14:35.000Z (about 7 years ago)
- Last Synced: 2025-01-16T13:59:10.063Z (over 1 year ago)
- Size: 40 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PulseDocs
Documentation for Stuypulse's Software Engineering division
## Usage
Pulsedocs uses MKDocs.
**Prerequisites:**
1) Ensure MKDocs is installed with `pip3 install mkdocs`
2) Ensure mkdocs-material is installed with `pip3 install mkdocs-material`
**Testing**
Test with `mkdocs serve` in the project's root directory
**Building for hosting**
Build with `mkdocs build` in the project's root directory.
Compiled html will be found in the `site/` folder
**Editing**
To add a page, create a markdown file somewhere in `docs/...`
and add an entry to `mkdocs.yml`. `mkdocs.yml` is a YAML file
(YAML is an easy-to-read data format) which determines the
documentation pages to be displayed and their heirarchy.
See https://www.mkdocs.org for details.