This repository contains the vault for the Obsidian Developer Docs.
A hosted version of this vault is available at https://docs.obsidian.md/.
You can contribute in several ways:
- Fix typos and mistakes: If you want to fix a typo or other small modifications, you can submit a pull request without creating an issue. For smaller edits, you can use the GitHub web interface instead of cloning the repository.
- Add missing, outdated, or clarifying content: If you want to add, remove, or expand on current content, please submit an issue before you start working on it. We will let you know if this is something that should be worked on, or not.
- Any contributions to the docs must follow our Style guide.
Warning
Any page in References/TypeScript API is automatically generated by scripts that pull from our codebase. We can accept issues on these files, but cannot accept direct PR's on them.
To make changes to Obsidian Developer docs:
- Fork the obsidian-developer-docs repository
- In the Obsidian vault switcher, select Open folder as vault
- Make your change in Obsidian
- Confirm the change is presentable in Reading View
- Commit your change to your fork
- Submit your PR to the obsidian-developer-docs repo for final review