GitHub
/
obsidian-encrypt-plugin
mirror of https://github.com/meld-cp/obsidian-encrypt.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

updated readme and docs index

main
meld-cp 5 months ago
parent
0e6f924218
commit
b0c9c6b3ee
2 changed files with 49 additions and 18 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 39
      README.md
  2. 28
      docs/index.md

39
README.md
Unescape View File

@ -1,24 +1,41 @@
# Obsidian Encrypt Plugin # [Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) Plugin for Obsidian
**Create encrypted notes within your [Obsidian.md](https://obsidian.md/) vault.** **Create Encrypted Notes Within Your [Obsidian.md](https://obsidian.md/) Vault**
[Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) is a community plugin that lets you encrypt and decrypt your notes in [Obsidian](https://obsidian.md/). You can choose to encrypt an [entire note](https://meld-cp.github.io/obsidian-encrypt/whole-encrypted-notes.html) or just [selected text within a note](https://meld-cp.github.io/obsidian-encrypt/in-place-encryption.html).
Encrypted notes are never decrypted to disk giving you peace-of-mind that the decrypted contents haven't been sync'd or backed up to external systems. Encrypted notes are never decrypted to disk giving you peace-of-mind that the decrypted contents haven't been sync'd or backed up to external systems.
---
> [!WARNING]
> ⚠️ Use at Your Own Risk ⚠️
> - Your passwords are never stored. If you forget your password, your notes cannot be decrypted..
> - The encryption methods used have not been independently audited. Unauthorized access may be possible if someone gains access to your files.
> - Bugs may be introduced at any time. You are solely responsible for maintaining backups of your notes.
---
## Ongoing Maintenance and Development
> ⚠️ WARNING - Use at your own risk ⚠️ If you find this plugin useful please support the ongoing maintenance and development by:
> - Your passwords are never stored anywhere, if you forget your passwords you can't decrypt your notes. * [Staring ⭐ this repo](https://github.com/meld-cp/obsidian-encrypt)
> - No known audits have been undertaken for the soundness of encryption methods being used. Unwanted decryption by a 3rd party may be possible if they have access to your files. * [Buying me a coffee ☕](https://www.buymeacoffee.com/cleon)
> - Bugs could be introduced to the software at anytime, you are responsible for having backups of your notes. * [Sponsoring ❤️ me](https://github.com/sponsors/meld-cp).
Thank you for your support 😊
## ⚜️ Latest Changes <a href="https://www.buymeacoffee.com/cleon" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 50px !important;" ></a>
<a href="https://www.buymeacoffee.com/cleon" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
Please visit the [Change Log](https://github.com/meld-cp/obsidian-encrypt/blob/main/CHANGELOG.md) for a listing of changes. ## Latest Changes
Report any bugs or feature requests [here](https://github.com/meld-cp/obsidian-encrypt/issues). Information about the latest release can be found on the [release notes](https://meld-cp.github.io/obsidian-encrypt/release-notes.html) page.
## ⚜️ Documentation Report any bugs or features requests [here](https://github.com/meld-cp/obsidian-encrypt/issues).
## Documentation
Documentation can be found [here](https://meld-cp.github.io/obsidian-encrypt/) Documentation can be found [here](https://meld-cp.github.io/obsidian-encrypt/)

28
docs/index.md
Unescape View File

@ -4,24 +4,38 @@ layout: default
nav_order: 1 nav_order: 1
--- ---
# Obsidian Encrypt # [Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) Plugin for Obsidian
## Create Encrypted Notes Within Your [Obsidian.md](https://obsidian.md/) Vault **Create Encrypted Notes Within Your [Obsidian.md](https://obsidian.md/) Vault**
Obsidian Encrypt is a community plugin that lets you encrypt and decrypt your notes in Obsidian. You can choose to encrypt an entire note or just selected text within a note. [Meld Encrypt](https://github.com/meld-cp/obsidian-encrypt) is a community plugin that lets you encrypt and decrypt your notes in [Obsidian](https://obsidian.md/). You can choose to encrypt an [entire note](https://meld-cp.github.io/obsidian-encrypt/whole-encrypted-notes.html) or just [selected text within a note](https://meld-cp.github.io/obsidian-encrypt/in-place-encryption.html).
Encrypted notes are never decrypted to disk giving you peace-of-mind that the decrypted contents haven't been sync'd or backed up to external systems. Encrypted notes are never decrypted to disk giving you peace-of-mind that the decrypted contents haven't been sync'd or backed up to external systems.
> ⚠️ WARNING - Use at Your Own Risk ⚠️ ---
> [!WARNING]
> ⚠️ Use at Your Own Risk ⚠️
> - Your passwords are never stored. If you forget your password, your notes cannot be decrypted.. > - Your passwords are never stored. If you forget your password, your notes cannot be decrypted..
> - The encryption methods used have not been independently audited. Unauthorized access may be possible if someone gains access to your files. > - The encryption methods used have not been independently audited. Unauthorized access may be possible if someone gains access to your files.
> - Bugs may be introduced at any time. You are solely responsible for maintaining backups of your notes. > - Bugs may be introduced at any time. You are solely responsible for maintaining backups of your notes.
Do you find this plugin useful? You can support further development by buying me a coffee: ---
## Ongoing Maintenance and Development
<a href="https://www.buymeacoffee.com/cleon" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a> If you find this plugin useful please support the ongoing maintenance and development by:
* [Staring ⭐ this repo](https://github.com/meld-cp/obsidian-encrypt)
* [Buying me a coffee ☕](https://www.buymeacoffee.com/cleon)
* [Sponsoring ❤️ me](https://github.com/sponsors/meld-cp).
Thank you for your support 😊 Thank you for your support 😊
Report any bugs or feature requests [here](https://github.com/meld-cp/obsidian-encrypt/issues). <a href="https://www.buymeacoffee.com/cleon" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 50px !important;" ></a>
## Latest Changes
Information about the latest release can be found on the [release notes](https://meld-cp.github.io/obsidian-encrypt/release-notes.html) page.
Report any bugs or features requests [here](https://github.com/meld-cp/obsidian-encrypt/issues).

Write Preview
Loading…
Cancel
Save