Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 RGSS CS Club

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Binary file added LICENSE-docusaurus
Binary file not shown.
42 changes: 11 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,21 @@
# Website
# RGSS CS Docs

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
[![Deployment status](https://github.com/RGSS-CS/documentation/actions/workflows/deploy.yml/badge.svg)](https://github.com/RGSS-CS/documentation/actions/workflows/deploy.yml)

## Installation
This is repository is for RGSS CS Club's documentation site for the any major projects and applications that the club makes.

```bash
yarn
```

## Local Development

```bash
yarn start
```
## Installation and Running

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
For running a temporary NON-PRODUCTION testing server

```bash
yarn build
npm install
npm start
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment
## License

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
```
This web application is built using Docusaurus; all code (e.g. `.js`,`.ts`,`.tsx` files) is currently licensed under [Docusaurus' MIT license](https://github.com/RGSS-CS/documentation/blob/main/LICENSE-docusaurus).
Our own documentation for the various projects (e.g. `.md` inside of `/docs` folder) is licensed under [RGSS CS Club's MIT license](https://github.com/RGSS-CS/documentation/blob/main/LICENSE).

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.
*This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.*
5 changes: 5 additions & 0 deletions TODO
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
Soon:
1. Construct mega docs
2. Mirror project directory in docs structure

Later:
1. Begin recording of Stuco Website changelog
2. Finish documentation of Stuco Website
3. Create content deliver network (cdn)/download (dl) subdomain
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ const config: Config = {
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} RGSS CS Club, Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,
Expand Down
Loading
Loading