From b7e378255dc329a12da4a397e0e683295571c4ea Mon Sep 17 00:00:00 2001 From: netwworkmastered Date: Sun, 9 Mar 2025 15:26:24 +0000 Subject: [PATCH] Update README to contain a warning and remove debugging logs from main. --- README.md | 7 +++++++ main.ts | 3 --- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7d7d7df..cfb0f3e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ This plugin is designed to take large files and then compress them. Can typicall ## Installation There are two ways to install this plugin which are as follows: + 1. Install it from the obsidian community plugins tab. + 2. Get the latest main.js and manifest.json from the github releases and drag it into your vault's ".obsidian/plugins/compressor" folder. The "compressor" folder may not be there. If not then you should be able to create one. If you are on linux the .obsidian folder may be hidden, depending on your operating system it will be different. You should be able to look up how to view hidden folders. Or optionally you can cd into it. ## How to use @@ -30,7 +32,12 @@ This plugin comes with two buttons. +NOTICE: +- By using this plugin the "Graph View" will NOT show links(if you know of a way to do this, please let me know). Linking to a ctxt file will also not show it.! +- Compressing a file that another plugin edits will stop that plugin from being able to open it, re convert it. + +- This plugin is not perfect. Data loss is possible. In the case of dataloss, please make sure that you didnt accidently edit/tamper with the compressed data. Then and only if your fine with sharing the file you could upload an issue request with the contents. DO NOT SHARE PERSONAL INFO! If there are any issues or requests, make sure to create a request! \ No newline at end of file diff --git a/main.ts b/main.ts index 5c50c5a..56dec86 100644 --- a/main.ts +++ b/main.ts @@ -92,7 +92,6 @@ export default class compressorPlugin extends Plugin { } catch (err) { console.log(err) } if (compress) { globalLeafs.forEach((leaf) => { - console.log(leaf) if (leaf[0] == "ctxt" && leaf[2] == file.path && leaf[3]) { // leaf[3].editor.setLine("") leaf[3].unload() @@ -105,7 +104,6 @@ export default class compressorPlugin extends Plugin { leaf[3].setViewData(data, true) } }) - console.log(file.name + " has been saved") } } }) @@ -137,7 +135,6 @@ export default class compressorPlugin extends Plugin { const ribbonIconEl3 = this.addRibbonIcon('up-and-down-arrows', 'Convert currently opened file', (evt: MouseEvent) => { if (confirm("Are you sure you want to convert")) { //will this work? electron confirms dont exit. Oh it does var file = this.app.workspace.getActiveFile() - console.log(file) if (file) { if (file.extension == "ctxt") { this.app.vault.read(file).then((data) => {