https://github.com/bridge-core/bridge-core.github.io
https://github.com/bridge-core/bridge-core.github.io
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bridge-core/bridge-core.github.io
- Owner: bridge-core
- Created: 2020-09-16T11:10:13.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-23T06:35:14.000Z (about 1 year ago)
- Last Synced: 2025-07-06T20:07:22.042Z (12 months ago)
- Language: HTML
- Homepage: https://bridge-core.app
- Size: 128 MB
- Stars: 8
- Watchers: 4
- Forks: 15
- Open Issues: 0
-
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.