https://github.com/obsidianmc/documentation
Documentation for ObsidianMC and Obsidian.API
https://github.com/obsidianmc/documentation
Last synced: about 1 year ago
JSON representation
Documentation for ObsidianMC and Obsidian.API
- Host: GitHub
- URL: https://github.com/obsidianmc/documentation
- Owner: ObsidianMC
- License: gpl-3.0
- Created: 2021-03-09T17:27:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-20T15:50:56.000Z (over 1 year ago)
- Last Synced: 2025-04-02T09:11:15.389Z (about 1 year ago)
- Language: Batchfile
- Size: 145 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Obsidian Documentation
## Building
### Requirements
- DocFX installed
- A build of Obsidian.API
### Steps
1. Add the build output to the `/src` folder. if it does not exist yet, create it.
2. Run `docfx --serve`. This will serve the current version documentation, and output the files to `/_site`.
### Contributing
Contributions are always welcome.
- Contributing to articles:
Modify markdown files located in the `/articles` folder. Images are in `/images`.
- Contributing to API documentation:
Api documentation is generated from source/binary files. To add to the API docs, contribute to [Obsidian.API](https://github.com/ObsidianMC/Obsidian/tree/master/Obsidian.API) itself.