Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vrchat-community/creator-docs

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/vrchat-community/creator-docs
Owner: vrchat-community
Created: 2023-05-26T23:16:32.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-30T23:49:37.000Z (2 months ago)
Last Synced: 2024-10-31T00:25:39.624Z (2 months ago)
Size: 65.4 MB
Stars: 7
Watchers: 14
Forks: 74
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

This repo holds the source for the VRChat Creator Docs!

![image](https://github.com/vrchat-community/creator-docs/assets/737888/0d5f6c1f-3c47-4a5d-8f2f-6207a7b33deb)

## Suggesting Edits

Please read the [contribution guide](https://creators.vrchat.com/contribute/) before suggesting an edit.

To suggest an edit to an existing page, you can use the "Edit this page" link at the bottom of most pages on the site.

![Suggesting Edits link](https://github.com/vrchat-community/creator-docs/assets/737888/0dfb0fdd-0bec-4bea-9ceb-9bb752655e6d)

GitHub will help you set up a fork of the docs so you can edit them and submit a Pull Request to this repo, to have your changes integrated.

## Local Development
You can also directly fork this repo to suggest many changes at once.
1. Fork the repo to your own GitHub account.
2. Edit the markdown docs on your own machine.
3. Use Docusaurus to preview the updates if you want!

## Using Docusaurus
The docs are built with [Docusaurus](https://docusaurus.io/docs/), so you can run a local server to see what your changes will look like very quickly.
1. Clone the repo (or your fork).
2. Run `npm install` in the `Docs` folder to install the required packages.
3. Run `npm run start` in the `Docs` folder to run the Docusaurus server, which will build the site and open a browser pointing to a local server with your live preview. Just change a page or add a new one, and the server will hot-reload the content so you can see it right away.