Obsidian Help
This repository contains the source for the Obsidian Help docs, along with the translations for each supported language.
The docs for each language are stand-alone vaults with a corresponding Obsidian Publish site.
Contribute
To contribute to Obsidian Help docs:
- Fork the obsidian-help repository.
- In the Obsidian vault switcher, select Open folder as vault.
- Select the subfolder for the translation you want to contribute to, for example
/en/. Don't open the root folder as a vault, as this may lead to links being updated incorrectly.
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. For smaller edits, you can use the GitHub web interface instead of cloning the repository.
- Add missing or outdated content: If you want to contribute missing or outdated content, please submit an issue before you start working on it.
Any contributions to the English docs must follow our Style guide.
Translations
Adding a new translation
If you want to add a new translation, either submit an issue or open a discussion to let us you know that you want to start working on it.
To add a new translation, copy the entire en folder and rename it to the corresponding ISO 639-1 language code in lowercase.
Each translation should follow the English docs (en) as closely as possible.
Staying up-to-date
As we add more features and continue to improve the English docs, translations will eventually become out-of-date.
To see all changes to the English docs since the last update to the translation, run the following in your terminal:
git diff <COMMIT_SHA> HEAD -- en/Replace <COMMIT_SHA> with the commit containing the latest changes for the translation.
Note: If a translation falls too far behind the English version, we may eventually remove it.
Roadmap
The Obsidian Help docs have grown considerably over the years. We're working on reorganizing some of the content to make things easier to find and understand.
The docs under the following folders have been updated to the new organization and style guide. If you're working on a translation, these are safe to work on (except for minor updates).
- Contributing to Obsidian
- Developers
- Editing and formatting
- Extending Obsidian
- Getting started
- Licenses and payment
- Obsidian Publish
- Obsidian Sync
- Plugins
The docs in the following folders have yet to be updated, and may change considerably in the future. Any work done on these docs has a high risk of becoming outdated.
- Advanced topics
- Concepts
- Customization
- How to
- User interface
Credits
To be featured on the Credits page, add yourself to the Credits file and to the corresponding translation.