Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Medium-Term Suggestion: Plugins pre-installed in the Community Vault? #52

Open
chrisgrieser opened this issue Oct 24, 2021 · 3 comments
Assignees
Labels
enhancement New feature or request medium-term

Comments

@chrisgrieser
Copy link
Member

As I have written in the overhauled CONTRIBUTING.md, I think there are some reasonable settings that contributors should have while contributing, e.g. having spellcheck turned on.

I was thinking: Would it maybe make sense to have a small set of plugin be considered "default plugins" for the community hub, which should always be active when someone is contributing? The following candidates come to my mind

  • Language Tool Plugin for improved language style, maybe with some sensitive configuration
  • (The Vale Plugin unfortunately relies on the Vale CLI being installed, which unnecessarily raises the threshold for contributors.)
  • Linter with some sensitive configuration for further cleaning up stuff. (Also has a rule to insert file names as H1, which is far less destructive than the Filename Heading Sync Plugin.)
  • Smart Typography for nicer quotation marks and stuff
  • Pipe Tricks, as it makes linking stuff easier
  • Perhaps something like Dangling Links or Find Unresolved Links, but since they work globally, I am not sure whether they make sense for everyone. Maybe for regular contributors
  • Show Current File Path could make sense as an extra layer preventing someone from accidentally creating a new note in the wrong folder

Feel free to also suggest plugins that would make sense

@SkepticMystic
Copy link
Contributor

I think this makes sense. At some point we shouldn't have too many plugins installed, and probably not plugins that don't preview on the Publish site. But plugins that help in the contribution process make sense.

@argenos
Copy link
Contributor

argenos commented Oct 24, 2021

Zoottelkeeper and Dangling links are two that we currently use.

I've also thought about the best way to distribute these, since the current approach .obsidian/app.json causes a lot of issues when pushed. My suggestion would be either another repo if we care about version history of the settings (which I don't think we do) or a zip file of the vault in the releases that includes the .obsidian folder (so plugins and settings) for contributors. I'm inclined to go for the latter.

I disliked the Linter plugin in the past as too opinionated. Does it still add stuff to the frontmatter?

@chrisgrieser
Copy link
Member Author

I disliked the Linter plugin in the past as too opinionated. Does it still add stuff to the frontmatter?
There are actually two or three plugins that do some sort of linting, I am referring to this one: https://github.com/platers/obsidian-linter

It also includes rules to add stuff to the frontmatter but they can simply be disabled to only use the rules we want/need.

Linter has the advantage not requiring any CLI like prettier, and all configurations being stored in the plugin settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request medium-term
Projects
None yet
Development

No branches or pull requests

3 participants