https://github.com/source-academy/documentation
Centralized documentation for all Source Academy repositories.
https://github.com/source-academy/documentation
Last synced: about 2 hours ago
JSON representation
Centralized documentation for all Source Academy repositories.
- Host: GitHub
- URL: https://github.com/source-academy/documentation
- Owner: source-academy
- Created: 2023-06-21T14:40:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T03:58:17.000Z (about 2 years ago)
- Last Synced: 2025-02-21T10:44:09.194Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 647 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Source Academy Documentation
> Centralised documentation for Source Academy.
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```bash
yarn
```
### Local Development
```bash
yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```bash
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
GIT_USER= yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.