search

silverbulletmd / silverbullet

The knowledge hacker's notebook
https://silverbullet.md
MIT License
2.27k stars 164 forks source link

Initial Setup suggestions #549

Open accforgithubtest opened 10 months ago

accforgithubtest commented 10 months ago

Hello and thank you for your work on this software first !

I recently found silverbullet and I thought I might share my initial observations, which while opinionated I hope will improve overall user experience.

  1. Separate out the silverbullet config files location from the docs location where md files are stored. This is very important l think, when anyone who already has docs / md files in an existing folder can take silverbullet for a spin, without worrying too much. Right now, only /space is mapped and silverbullet wants to write the settings file to that location, which is not ideal.
  2. More clarity on what settings.md is about ? Currently, It looks like the only (??) setting in settings.md is for index file - which could be set as a environment var and this file is not needed ? If there are more settings, perhaps separating them into a silverbullet specific folder (as mentioned above) would be better ?
  3. Support a read-only mode via an environment var ? If there is a environment var where we can tell silverbullet to operate in a read-only mode, that will be nice
  4. An Env var to start silver bullet in dark mode by default ?
  5. Render / Support mermaid diagrams as supported by other prominenet tools like markdown-preview-enhanced, mkdocs, etc

graph TD;

A --> B; A --> C; C -->D



Thank you again for this software and keen to hear your thoughts / opinions so I can also understand how silverbullet is supposed to be setup / used properly.
zefhemel commented 10 months ago

First of all, thanks for writing this up!

  1. Hmm, yeah this is an option. I'm not 100% happy with how settings are handled now in general, but my thinking was "everything is a page, so let's put settings in a page too" that way it travels with the content, just like plugs do (which are kept in _plugs if you install custom ones).
  2. Again, not super happy with the settings systems, but there are many more supported settings: https://silverbullet.md/SETTINGS I've just updated the default-generated SETTINGS page with a link to that page (will be part of the next release).
  3. Not yet, but this has been suggested before: https://github.com/silverbulletmd/silverbullet/issues/161 what would be your use case?
  4. I'd rather create a SETTINGS setting for this than polluting the environment variable namespace with even more settings. The reason I haven't put it in SETTINGS is that I can imagine this is a per-client setting, not per space. Perhaps you want dark mode on your desktop, but not mobile for instance.
  5. This is already supported with the mermaid plug: https://github.com/silverbulletmd/silverbullet-mermaid