https://github.com/bridge-core/docs
https://github.com/bridge-core/docs
hacktoberfest
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bridge-core/docs
- Owner: bridge-core
- Created: 2022-07-13T10:07:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-06-04T00:54:36.000Z (about 1 year ago)
- Last Synced: 2025-06-04T08:11:08.741Z (about 1 year ago)
- Topics: hacktoberfest
- Homepage:
- Size: 40.1 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bridge-core/docs
The bridge-core/docs directory contains reference documentation for the add-on editor bridge. v2.
## Contributing
Thanks for considering to contribute to the bridge-core/docs project.
To get started, first make sure that you have NodeJS installed. Then, follow the steps below.
1. Fork this repository and clone it to your computer.
2. Run `npm install` within the cloned repository.
3. Run `npm run dev` to start the development server.
We use Prettier to automatically format our code. If you use VS Code, we recommend you to install the Prettier extension.
### Style Guide
#### Spelling
- **Add-On**, not addon or AddOn
- **do not**, not don't
#### Guides
All guides should have a section outlining what users can learn from them.
[See Example](./docs/guide/advanced/dash/index.md)
#### API Documentation
When describing the format of a JSON file, use a style similar to [this one](./docs/extensions/presets/manifest.md).
Alternatively, you can work with code snippets and add comments to them.