obsidianmd / obsidianmd/obsidian-sample-plugin
Feature request — expanding the sample plugin with more examples/features
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4.5k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Speaking from personal experience, and a very skimpy coding background, getting started with Obsidian plugins is very hard.
There are very few guides and examples to find, and the documentation is sparse. Looking through the code of existing plugins on GitHub is a good option, but it's hard to know which have the functionality you're looking to replicate, and many are so expansive that isolating one feature can be daunting for a newcomer.
I would like to suggest expanding this sample plugin with more examples/features/functionality.
Some suggestions could be:
- how to create a leaf for a plugin in the right sidebar
- how to perform a search of a given word/words in a document
- how to output HTML for leaf content layouts
- some examples of how scoping works
I realise that my low skill level means that I need more help than most, but I'm sure that others would find it useful to have this plugin fleshed out a bit as well. Hopefully, someone with more skill than I will be able to look into some of these suggestions 😃
Thanks for an awesome piece of software!
Cheers.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by reviewing the current sample plugin structure and its existing documentation, then define which example features are in scope; done should mean the selected examples are implemented and documented, but this issue does not specify a concrete stopping point.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100