https://github.com/obsidianmd/obsidian-developer-docs

https://github.com/obsidianmd/obsidian-developer-docs

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/obsidianmd/obsidian-developer-docs
• Owner: obsidianmd
• Created: 2023-01-09T23:50:01.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-30T23:25:09.000Z (8 months ago)
• Last Synced: 2024-03-31T00:23:29.193Z (8 months ago)
• Language: JavaScript
• Size: 3.17 MB
• Stars: 98
• Watchers: 6
• Forks: 42
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - obsidianmd/obsidian-developer-docs - (JavaScript)

README

        
# Obsidian Developer Docs

This repository contains the vault for the Obsidian Developer Docs.

A hosted version of this vault is available at https://docs.obsidian.md/.

## Contributing

**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](https://github.com/obsidianmd/obsidian-developer-docs/issues/new) 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](https://help.obsidian.md/Contributing+to+Obsidian/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](https://github.com/obsidianmd/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