Step-by-step tutorials and how-to guides for using plugins built with this template.

Getting Started

• Installation Guide - How to install the plugin
• Quick Start - Get up and running in 5 minutes
• Basic Usage - Common tasks and workflows

Guides by Topic

Configuration

• Settings Guide - Configure the plugin
• Keyboard Shortcuts - Set up custom hotkeys

Usage

• Common Tasks - Frequently performed operations
• Advanced Features - Power user techniques
• Troubleshooting Guide - Fix common issues

Integration

• Theme Compatibility - Using with custom themes
• Plugin Interactions - Working with other plugins
• Mobile Usage - Using on mobile devices

Reference

• FAQ - Frequently asked questions
• Glossary - Common terms and concepts

Quick Start

1. Install the Plugin

Follow the installation guide to install the plugin in your vault.

2. Enable the Plugin

1. Open Obsidian Settings
2. Go to Community plugins
3. Find the plugin in the list
4. Toggle it ON

3. Configure Basic Settings

1. Click the gear icon next to the plugin
2. Review and adjust settings
3. Save changes

4. Try It Out

• Open the command palette (Ctrl/Cmd + P)
• Search for plugin commands
• Try out the basic features

5. Learn More

• Read the features guide
• Browse through these guides
• Check out the examples

Basic Usage

Opening the Command Palette

Keyboard: Ctrl/Cmd + P

The command palette provides quick access to all plugin features.

Using Commands

1. Open command palette
2. Type to search for commands
3. Press Enter to execute
4. Use Tab to autocomplete

Accessing Settings

Path: Settings → Community plugins → [Plugin Name] → Settings (gear icon)

Settings allow you to customize plugin behavior.

Common Workflows

Workflow 1: Basic Operation

1. Open command palette (Ctrl/Cmd + P)
2. Search for “Plugin: Command Name”
3. Execute the command
4. Review results

Workflow 2: Custom Configuration

1. Open plugin settings
2. Adjust configuration options
3. Save changes
4. Test the configuration

Workflow 3: Troubleshooting

1. Enable debug logging in settings
2. Reproduce the issue
3. Check debug-log.txt in vault root
4. Report issue with log information

Getting Help

Documentation

• Features Overview - What the plugin can do
• Installation Guide - Setup instructions
• FAQ - Common questions

Community

• GitHub Issues - Report bugs or request features
• GitHub Discussions - Ask questions
• Obsidian Discord - General plugin help

Reporting Issues

When reporting issues, include:

• ✅ Obsidian version
• ✅ Plugin version
• ✅ Operating system
• ✅ Steps to reproduce
• ✅ Expected vs actual behavior
• ✅ Debug log (if applicable)

Contributing

Found an error in the documentation? Want to add a guide?

1. Fork the repository
2. Make your changes
3. Submit a pull request

See Contributing Guide for details.

Next Steps

• Explore Common Tasks
• Learn about Advanced Features
• Check the FAQ for answers to common questions

---

Need help? Create an issue or check the FAQ.