https://github.com/jupyter-book/team-compass
A team compass for the Jupyter Book sub-project
https://github.com/jupyter-book/team-compass
jupyter jupyter-book myst
Last synced: 7 months ago
JSON representation
A team compass for the Jupyter Book sub-project
- Host: GitHub
- URL: https://github.com/jupyter-book/team-compass
- Owner: jupyter-book
- Created: 2024-05-20T16:38:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-11T15:19:52.000Z (8 months ago)
- Last Synced: 2025-02-11T16:28:37.185Z (8 months ago)
- Topics: jupyter, jupyter-book, myst
- Homepage: https://compass.jupyterbook.org
- Size: 44.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Code of conduct: docs/code-of-conduct.md
- Governance: docs/governance.md
Awesome Lists containing this project
README
# The Jupyter Book Team Compass
✨ Live site: [compass.jupyterbook.org](https://jupyterbook.org).
📚 Source files: [`docs/`](docs/)
## Build the documentation locally
This site is built with [the MyST Document Engine](https://mystmd.org).
To build it locally:
1. Install MyST from PyPI:
```
pip install mystmd
```
2. Clone the repository and change into the `docs/` folder:
```
git clone https://github.com/jupyter-book/team-compass
cd team-compass/docs
```
3. Start the MyST server:
```
myst start
```
For more information on building sites with MyST, see [the MyST Guide](https://mystmd.org/guide).