How arnaudhrn/obsidian-share works
Obsidian Share turns a local vault into a password-protected website: preparation converts notes and assets, optional Dataview and STL processing enriches them, and FTP publishes the result for PHP rendering and browsing. The browser UI, authentication, and 3D viewer are distinct user-facing capabilities. Some implementation details are unsampled; edges are limited to README statements and source-index references.
Main entry points: prepare_folder.py Prepare notes · __init__.py Dataview facade · ftp_utils.py FTP transfer · executor.py Query execution
Components 19
Local preparation
- Prepare notes
scripts/prepare_folder.py - Deployment config
scripts/config.py - FTP transfer
scripts/ftp_utils.py
Dataview processing
- Dataview facade
scripts/dataview/__init__.py - Query parser
scripts/dataview/parser.py - Note data extraction
scripts/dataview/data_extractor.py - Query execution
scripts/dataview/executor.py - Expression evaluation
scripts/dataview/evaluator.py - Query functions
scripts/dataview/functions.py - Markdown output
scripts/dataview/renderer.py
Published site
- Published notes
server/config.json - Login and browser UI
server/index.php - Markdown rendering
server/view.php - 3D STL viewer
server/viewer.php
Asset processing
- STL processor
scripts/stl/__init__.py - STL link detection
scripts/stl/extractor.py - STL copy and rewrite
scripts/stl/processor.py
Other components
- Obsidian vault
- Site visitor
Connections 20
- Obsidian vault → Prepare notes: prepares
README.md - Prepare notes → Dataview facade: invokes
scripts/prepare_folder.py - Dataview facade → Query parser: uses
scripts/dataview/__init__.py - Dataview facade → Query execution: uses
scripts/dataview/__init__.py - Dataview facade → Markdown output: uses
scripts/dataview/__init__.py - Query execution → Note data extraction: reads data
scripts/dataview/executor.py - Query execution → Query functions: uses
scripts/dataview/executor.py - Markdown output → Query functions: uses
scripts/dataview/renderer.py - Prepare notes → STL processor: invokes
scripts/prepare_folder.py - STL processor → STL link detection: detects links
scripts/stl/__init__.py - STL processor → STL copy and rewrite: rewrites files
scripts/stl/__init__.py - STL copy and rewrite → STL link detection: extracts links
scripts/stl/processor.py - Prepare notes → Deployment config: reads settings
scripts/prepare_folder.py - FTP transfer → Deployment config: reads settings
scripts/ftp_utils.py - Prepare notes → FTP transfer: uploads via
scripts/prepare_folder.py - FTP transfer → Published notes: publishes files
README.md - Site visitor → Login and browser UI: opens site
README.md - Login and browser UI → Published notes: serves notes
README.md - Login and browser UI → Markdown rendering: renders notes
server/index.php - Site visitor → 3D STL viewer: views models
README.md