https://github.com/sourcebots/docs
Documentation
https://github.com/sourcebots/docs
documentation web
Last synced: about 1 month ago
JSON representation
Documentation
- Host: GitHub
- URL: https://github.com/sourcebots/docs
- Owner: sourcebots
- Created: 2017-07-11T15:44:46.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T18:28:59.000Z (over 2 years ago)
- Last Synced: 2024-04-15T08:10:53.296Z (about 2 years ago)
- Topics: documentation, web
- Homepage: https://docs.sourcebots.co.uk/
- Size: 14.9 MB
- Stars: 2
- Watchers: 17
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SourceBots Documentation
[](https://github.com/sourcebots/docs/actions/workflows/ci.yml)
URL: https://docs.sourcebots.co.uk
## Installation
To run this project locally, you'll need:
- Python (`>=3.6, <3.12`)
- `pip`
## Usage
### Installing dependencies
It's recommended to use a [virtual environment](https://docs.python.org/3/tutorial/venv.html):
```
python -m venv env
env\Scripts\activate.bat # on windows
source env/bin/activate # on macOS / Linux
```
Then, install dependencies:
```
pip install -r requirements.txt
```
### Running development server
```
mkdocs serve
```
This will launch a server on http://localhost:8000. Content in the server will live-reload as changes are made. If large refactors of the site structure are made, it's advisable to stop the server, make the changes, then restart it.
### Production build
```
mkdocs build
```
This will build the site once, and place it in `site/` in the root of the project. This may be useful to see which files are rendered, and how exactly to access them.
### Spell checking
This project uses `cspell` for spell checking. Plugins are
available for a variety of editors and a command line runner is available
through `npm`:
```
npm install
```
```
npm run spellcheck
```
Words that `cspell` is unaware of can be added to the `.spelling` file.