OBSIDIAN-SUBMISSION.md

Obsidian Community Plugin Submission

Plugin Information

• Plugin Name: Linian
• Plugin ID: linian
• Repository: https://github.com/dotMavriQ/Linian
• Author: Jonatan Jansson (@dotMavriQ)
• Description: Convert Linear issue shortcodes into clickable links with status-based styling

Requirements Checklist

✅ Repository Requirements

• Plugin hosted on GitHub
• Repository is public
• Repository has proper README with installation instructions
• Repository has releases with built plugin files
• main.js, manifest.json, and styles.css in releases
• Plugin follows Obsidian API guidelines

✅ Plugin Requirements

• Plugin works without internet connection (with cached data)
• Plugin doesn't make excessive API calls (uses caching)
• Plugin doesn't modify Obsidian's core functionality
• Plugin has proper error handling
• Plugin is responsive and performant

✅ Code Quality

• TypeScript source code
• Proper error handling
• No sensitive data in repository
• Clean, documented code
• Follows Obsidian plugin best practices

✅ Documentation

• Clear README with usage instructions
• Installation instructions
• Configuration guide
• Troubleshooting section
• Proper licensing (MIT)

Submission Process

1. Create Initial Release:

   git add .
   git commit -m "feat: initial release v1.0.0"
   git tag v1.0.0
   git push origin main
   git push origin v1.0.0

2. Verify Release:

   • Check that GitHub Actions built and published the release
   • Verify main.js, manifest.json, styles.css are in release assets
   • Test the plugin from the release files

3. Submit to Obsidian:

   • Fork https://github.com/obsidianmd/obsidian-releases
   • Add plugin to community-plugins.json
   • Create pull request

Obsidian Plugin Store Guidelines

Plugin Approval Criteria:

• ✅ Functionality: Plugin provides clear value to users
• ✅ Quality: Well-coded, tested, stable
• ✅ Documentation: Clear instructions and descriptions
• ✅ Maintenance: Active development and issue responses
• ✅ Guidelines: Follows all Obsidian plugin guidelines

Submission Requirements:

• ✅ Public GitHub repo with source code
• ✅ Releases with built plugin files (main.js, manifest.json, styles.css)
• ✅ manifest.json with correct format and required fields
• ✅ README.md with installation and usage instructions
• ✅ No sensitive data or API keys in repository

Post-Submission

Once approved:

• Plugin will appear in Obsidian's Community Plugins
• Users can install directly from Obsidian
• Updates pushed through new GitHub releases
• Maintain backwards compatibility when possible