https://github.com/bepinex/bepinex-docs
Documentation and API pages for BepInEx
https://github.com/bepinex/bepinex-docs
Last synced: over 1 year ago
JSON representation
Documentation and API pages for BepInEx
- Host: GitHub
- URL: https://github.com/bepinex/bepinex-docs
- Owner: BepInEx
- Created: 2021-06-25T09:55:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-06T16:40:13.000Z (over 1 year ago)
- Last Synced: 2025-01-14T15:52:39.390Z (over 1 year ago)
- Homepage: https://docs.bepinex.dev
- Size: 1.87 MB
- Stars: 3
- Watchers: 3
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BepInEx Documentation
This is the repo for storing documentation related to [BepInEx](https://github.com/BepInEx/BepInEx).
## [View the docs](https://docs.bepinex.dev/)
## Contributing
All contributions either via PRs or issues are welcome!
This project uses [DocFX](https://dotnet.github.io/docfx/) to render the API documentation and the articles.
Please refer to DocFX documentation for information on using [DocFX-flavoured markdown](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html?tabs=tabid-1%2Ctabid-a).
In general, you should be able to update pages with a simple markdown editor.
### Testing docs locally
If you want to preview the docs locally, you need .NET 5 or newer installed.
After that, do the following:
1. Clone this repo with `git clone`
2. In the cloned directory, run
```
git worktree add --checkout common common
```
A folder named `common` should appear.
2. Write documentation into `api` or `articles` folder. Refer to [docfx guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) and [DFM syntax guide](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html) for info on writing the guides using DocFX
3. Run `common/build.bat --target=Build` to build the docs. The generated docs will appear in `_site` folder