From b03138c3d4c2bf123e5da8cb451f9f3ed3006583 Mon Sep 17 00:00:00 2001 From: Gamosoft Date: Sat, 15 Nov 2025 18:01:40 +0100 Subject: [PATCH] moved documents --- .gitignore | 2 +- README.md | 43 ++++++++++++------- {data => documentation}/API.md | 0 {data => documentation}/AUTHENTICATION.md | 0 {data => documentation}/FEATURES.md | 0 {data => documentation}/MATHJAX.md | 0 {data => documentation}/PLUGINS.md | 0 .../PLUGIN_NOTE_STATISTICS.md | 0 {data => documentation}/THEMES.md | 0 9 files changed, 28 insertions(+), 17 deletions(-) rename {data => documentation}/API.md (100%) rename {data => documentation}/AUTHENTICATION.md (100%) rename {data => documentation}/FEATURES.md (100%) rename {data => documentation}/MATHJAX.md (100%) rename {data => documentation}/PLUGINS.md (100%) rename {data => documentation}/PLUGIN_NOTE_STATISTICS.md (100%) rename {data => documentation}/THEMES.md (100%) diff --git a/.gitignore b/.gitignore index 3a1b094..5b26cd4 100644 --- a/.gitignore +++ b/.gitignore @@ -28,7 +28,7 @@ env/ .venv # Data directories -search_index/ +data/ *.db *.sqlite diff --git a/README.md b/README.md index 142f973..7804a52 100644 --- a/README.md +++ b/README.md @@ -51,17 +51,18 @@ Use the pre-built image directly from GHCR - no building required! > **๐Ÿ’ก Tip**: Always use `ghcr.io/gamosoft/notediscovery:latest` to get the newest features and fixes. Images are automatically built when PRs are merged to main. > **๐Ÿ“ Important - Volume Mapping**: The container needs local folders/files to work: -> - **Required**: `data` folder (your notes will be stored here) +> - **Required**: `data` folder - **Your personal notes** will be stored here (create an empty folder) > - **Required**: `themes` folder with theme `.css` files (at least light.css and dark.css) > - **Required**: `plugins` folder (can be empty for basic functionality) > - **Required**: `config.yaml` file (needed for the app to run) +> - **Optional**: `documentation` folder - If you cloned the repo, mount this to view app docs inside NoteDiscovery > > **Setup Options:** > > 1. **Minimal** (quick test - download just the essentials): > ```bash > # Linux/macOS -> mkdir -p data plugins themes +> mkdir -p data plugins themes # data/ is for YOUR notes > curl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml > # Download at least light and dark themes > curl -o themes/light.css https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css @@ -70,21 +71,22 @@ Use the pre-built image directly from GHCR - no building required! > > ```powershell > # Windows PowerShell -> mkdir data, plugins, themes -Force +> mkdir data, plugins, themes -Force # data\ is for YOUR notes > Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/config.yaml -OutFile config.yaml > # Download at least light and dark themes > Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/light.css -OutFile themes/light.css > Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/themes/dark.css -OutFile themes/dark.css > ``` > -> 2. **Full Setup** (recommended - includes all themes, plugins, sample notes): +> 2. **Full Setup** (recommended - includes all themes, plugins, and documentation): > ```bash > git clone https://github.com/gamosoft/notediscovery.git > cd notediscovery -> # Now you have everything - run docker-compose below +> # The data/ folder is empty - for your personal notes +> # The documentation/ folder has app docs you can optionally mount > ``` -> **๐Ÿ” Security Note**: Authentication is **enabled by default** with password `admin`. For testing/local use, this is fine. If exposing to a network, **change the password immediately** - see [AUTHENTICATION.md](data/AUTHENTICATION.md) for instructions. +> **๐Ÿ” Security Note**: Authentication is **enabled by default** with password `admin`. For testing/local use, this is fine. If exposing to a network, **change the password immediately** - see [AUTHENTICATION.md](documentation/AUTHENTICATION.md) for instructions. **Option 1: Docker Compose (Recommended)** @@ -201,16 +203,25 @@ python run.py Want to learn more? **The full documentation lives inside the app as interactive notes!** Once you've started NoteDiscovery, you'll find comprehensive guides on: -- ๐ŸŽจ **THEMES.md** - Theme customization and creating custom themes -- โœจ **FEATURES.md** - Complete feature list and keyboard shortcuts -- ๐Ÿงฎ **MATHJAX.md** - LaTeX/Math notation examples and syntax reference -- ๐Ÿ”Œ **PLUGINS.md** - Plugin system and available plugins -- ๐ŸŒ **API.md** - REST API documentation and examples -- ๐Ÿ” **AUTHENTICATION.md** - Enable password protection for your instance +- ๐ŸŽจ **[THEMES.md](documentation/THEMES.md)** - Theme customization and creating custom themes +- โœจ **[FEATURES.md](documentation/FEATURES.md)** - Complete feature list and keyboard shortcuts +- ๐Ÿงฎ **[MATHJAX.md](documentation/MATHJAX.md)** - LaTeX/Math notation examples and syntax reference +- ๐Ÿ”Œ **[PLUGINS.md](documentation/PLUGINS.md)** - Plugin system and available plugins +- ๐ŸŒ **[API.md](documentation/API.md)** - REST API documentation and examples +- ๐Ÿ” **[AUTHENTICATION.md](documentation/AUTHENTICATION.md)** - Enable password protection for your instance -**Can't wait to start the app?** Browse the documentation notes directly on GitHub in the [`data/`](data/) folder! +**Can't wait to start the app?** Browse the documentation notes directly on GitHub in the [`documentation/`](documentation/) folder! -๐Ÿ’ก **Tip:** These documentation files are regular markdown notesโ€”edit them, add your own notes, or use them as templates. It's your knowledge base! +๐Ÿ’ก **Pro Tip:** If you clone this repository, you can mount the `documentation/` folder to view these docs inside the app: + +```yaml +# In your docker-compose.yml +volumes: + - ./data:/app/data # Your personal notes + - ./documentation:/app/docs:ro # Mount docs (read-only) +``` + +Then access them at `http://localhost:8000` - the docs will appear as a `docs/` folder in the file browser! ## ๐Ÿ’– Support Development @@ -229,14 +240,14 @@ NoteDiscovery is designed for **self-hosted, private use**. Please keep these se ### Authentication - **Password protection is ENABLED by default** with password: `admin` - โš ๏ธ **CHANGE THE DEFAULT PASSWORD IMMEDIATELY** if exposing to a network! -- See **[AUTHENTICATION.md](data/AUTHENTICATION.md)** for complete setup instructions +- See **[AUTHENTICATION.md](documentation/AUTHENTICATION.md)** for complete setup instructions - To disable auth, set `security.enabled: false` in `config.yaml` - Change password with Docker: `docker-compose exec notediscovery python generate_password.py` - Perfect for single-user or small team deployments - For multi-user setups, consider a reverse proxy with OAuth/SSO ### Data Privacy -- Your notes are stored as **plain text markdown files** in `data/` +- Your notes are stored as **plain text markdown files** in the `data/` folder - No data is sent to external services - Regular backups are recommended diff --git a/data/API.md b/documentation/API.md similarity index 100% rename from data/API.md rename to documentation/API.md diff --git a/data/AUTHENTICATION.md b/documentation/AUTHENTICATION.md similarity index 100% rename from data/AUTHENTICATION.md rename to documentation/AUTHENTICATION.md diff --git a/data/FEATURES.md b/documentation/FEATURES.md similarity index 100% rename from data/FEATURES.md rename to documentation/FEATURES.md diff --git a/data/MATHJAX.md b/documentation/MATHJAX.md similarity index 100% rename from data/MATHJAX.md rename to documentation/MATHJAX.md diff --git a/data/PLUGINS.md b/documentation/PLUGINS.md similarity index 100% rename from data/PLUGINS.md rename to documentation/PLUGINS.md diff --git a/data/PLUGIN_NOTE_STATISTICS.md b/documentation/PLUGIN_NOTE_STATISTICS.md similarity index 100% rename from data/PLUGIN_NOTE_STATISTICS.md rename to documentation/PLUGIN_NOTE_STATISTICS.md diff --git a/data/THEMES.md b/documentation/THEMES.md similarity index 100% rename from data/THEMES.md rename to documentation/THEMES.md