obsidian-plugin/markusmo3_obsidian-private-mode
1
0
Fork 0
mirror of https://github.com/markusmo3/obsidian-private-mode.git synced 2026-07-22 05:42:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Moved dev only documentation

Browse source
This commit is contained in:
Markus Moser 2025-03-13 10:51:11 +01:00
parent 6fdfdf1a0e
commit a0a398752c
No known key found for this signature in database
GPG key ID: AD411FF94FFE07BD
2 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,10 @@
# Releasing
You can simplify the version bump process by running npm version patch, npm version minor or npm version major after updating minAppVersion manually in manifest.json. The command will bump version in manifest.json and package.json, and add the entry for the new version to versions.json
There is an automatic GitHub release workflow in place that gets triggered on a push of a tag.
To push a tag:
```bash
git tag 1.0.1
git push origin 1.0.1
```

9
README.md
View file

@ -32,14 +32,5 @@ The plugin is not available on the community page, as its mostly for me personal
* to compile the scss you can use sass `npm install -g sass` and `sass styles.scss styles.css`
5. Enable the plugin in your Obsidian in the Settings panel "Community Plugins"
# Releasing
There is an automatic GitHub release workflow in place that gets triggered on a push of a tag.
To push a tag:
```bash
git tag 1.0.1
git push origin 1.0.1
```
# Credits
Huge thanks to [Privacy Glasses](https://github.com/jillalberts/privacy-glasses/tree/master) for the groundwork and being licensed under MIT. Use that plugin if you want a more in depth configuration. I personally didn't need or want that much customization and overhead in my plugin. Also i found the "flickering" when opening any file to be too distracting, so i created a simpler version for myself.