https://github.com/y-scope/yscope-docs
The repo backing docs.yscope.com
https://github.com/y-scope/yscope-docs
Last synced: 5 months ago
JSON representation
The repo backing docs.yscope.com
- Host: GitHub
- URL: https://github.com/y-scope/yscope-docs
- Owner: y-scope
- Created: 2023-03-15T14:22:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-03T10:32:10.000Z (6 months ago)
- Last Synced: 2025-12-06T13:33:47.266Z (6 months ago)
- Language: Python
- Homepage: https://docs.yscope.com
- Size: 154 KB
- Stars: 0
- Watchers: 10
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# YScope Docs
This repo contains the source for YScope's docs hub at [docs.yscope.com].
# Development
Follow the steps below to build and view the site locally.
## Requirements
* [Node.js] >= 16 to be able to [view the output](#viewing-the-output)
* python3 >= 3.10
* python3-venv
* [Task]
## Building
* Build the site incrementally:
```shell
task docs:build
```
* The output of the build will be in `build/html`.
* Clean-up the build:
```shell
task clean
```
## Viewing the output
```shell
task docs:serve
```
[docs.yscope.com]: https://docs.yscope.com
[Node.js]: https://nodejs.org/en/download/current
[Task]: https://taskfile.dev/