https://github.com/vrchat-community/creator-companion
The Entry Point for Making Things in VRChat
https://github.com/vrchat-community/creator-companion
vrchat
Last synced: 11 days ago
JSON representation
The Entry Point for Making Things in VRChat
- Host: GitHub
- URL: https://github.com/vrchat-community/creator-companion
- Owner: vrchat-community
- Created: 2022-08-26T18:32:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T21:12:32.000Z (18 days ago)
- Last Synced: 2025-04-15T02:13:46.891Z (11 days ago)
- Topics: vrchat
- Homepage: https://vrchat.com/home/download
- Size: 2.25 MB
- Stars: 72
- Watchers: 11
- Forks: 549
- Open Issues: 254
-
Metadata Files:
- Readme: Docs/README.md
Awesome Lists containing this project
README
# Creator Companion Documentation Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Suggesting changes
Suggesting changes to [vcc.docs.vrchat.com](https://vcc.docs.vrchat.com/) is easy! Click [🖊Edit this page](https://github.com/vrchat-community/creator-companion/edit/main/Docs/docs/index.md) at the bottom of any page.
GitHub will ask you to
1. [Sign up](https://github.com/join) for a free GitHub account,
2. [Create a fork](https://github.com/vrchat-community/creator-companion/fork) of this repository,
3. [Edit the page](https://github.com/vrchat-community/creator-companion/edit/main/Docs/docs/index.md) with GitHub's built-in Markdown editor,
4. And [submit a Pull Request](https://github.com/vrchat-community/creator-companion/compare) to have your changes reviewed and merged into our documentation.
## (Advanced) Previewing Docusaurus
If you're an advanced user, you can run Docusaurus 2 locally to preview your changes.
More information on deploying and locally testing Docusaurus websites can be found on [Docusaurus's deployment guide].
### Installation
```
$ yarn
```
### Local Development
```
$ 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.