silmaril 0.1.0__tar.gz

silmaril-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniil Merkulov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

silmaril-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+include app.py
+recursive-include silmaril/static *

silmaril-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: silmaril
+Version: 0.1.0
+Summary: Self-hosted, mobile-first web UI for browsing and editing Obsidian vaults
+Author-email: Daniil Merkulov <bratishka.mipt@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/MerkulovDaniil/silmaril
+Project-URL: Repository, https://github.com/MerkulovDaniil/silmaril
+Keywords: obsidian,vault,viewer,markdown,notes,self-hosted
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: uvicorn>=0.20.0
+Requires-Dist: python-frontmatter>=1.0.0
+Requires-Dist: markdown>=3.4
+Requires-Dist: pyyaml>=6.0
+Dynamic: license-file
+
+# Silmaril
+
+A self-hosted, mobile-first web UI for browsing and editing Obsidian vaults from any device. Single Python file, zero config. Inspired by [notion4ever](https://github.com/MerkulovDaniil/notion4ever).
+
+```mermaid
+graph LR
+    V[("📂 Your Vault")] --- S{{"⚡ silmaril"}}
+    S <-->|browse| P["📱 Phone"]
+    S <-->|search| D["🖥️ Desktop"]
+    S <-->|edit| L["💻 Laptop"]
+```
+
+> **Your vault stays in one place. You access it from anywhere.**
+
+## Why?
+
+If your vault lives on a VPS or a desktop machine and you want to access it from your phone or any browser — this is for you. All my attempts to sync vaults across devices (Remotely Save, third-party sync plugins) kept failing with conflicts and silent data loss. Obsidian Sync works, but costs money and requires the app on every device.
+
+Silmaril takes a different approach: **your vault stays in one place, you access it from anywhere**. Point it at a directory, open a URL — browse, search, edit. It just works.
+
+It renders most of what Obsidian renders: wiki-links, embeds, callouts, KaTeX math, frontmatter properties, cover images, Bases, Iconic plugin icons. It won't replace Obsidian for heavy workflows with lots of plugins or complex Dataview queries, but for reading, quick edits, and staying on top of your notes from a phone — it's a lifesaver.
+
+## Features
+
+- **Markdown rendering** with full Obsidian flavor: `[[wiki-links]]`, `![[embeds]]`, callouts, highlights, checkboxes
+- **KaTeX** math rendering (`$inline$` and `$$display$$`)
+- **Obsidian Bases** (`.base` files) with cards, list, and table views
+- **Iconic plugin** support with native icon editing (Lucide + emoji picker)
+- **Cover images** from frontmatter (`banner`, `cover`, `image`)
+- **Frontmatter badges** (status, tags) with color coding
+- **Full-text search** with instant sidebar filtering and content snippets
+- **Cards / List / Table views** for any directory
+- **Clean URLs** — `/notes/ideas.md` not `/view/notes/ideas.md`
+- **Mobile-first** responsive design
+- **Edit and delete** notes in the browser (`?edit`, `?raw`)
+- **Code blocks** with copy button
+- **File tree** sidebar with collapsible folders
+
+## Installation
+
+```bash
+pip install silmaril
+```
+
+Then run:
+
+```bash
+silmaril --vault /path/to/your/vault
+```
+
+Open [http://localhost:8000](http://localhost:8000) in your browser.
+
+### From source
+
+```bash
+git clone https://github.com/MerkulovDaniil/silmaril.git
+cd silmaril
+pip install .
+silmaril --vault /path/to/your/vault
+```
+
+Or run directly without installing:
+
+```bash
+pip install fastapi uvicorn python-frontmatter markdown pyyaml
+python app.py --vault /path/to/vault
+```
+
+## Configuration
+
+### CLI arguments
+
+| Argument  | Env variable | Default     | Description                    |
+|-----------|-------------|-------------|--------------------------------|
+| `--vault` | `VAULT_ROOT`| `./vault`   | Path to your Obsidian vault    |
+| `--host`  | `VAULT_HOST`| `0.0.0.0`   | Bind address                   |
+| `--port`  | `VAULT_PORT`| `8000`      | Bind port                      |
+| `--title` | `VAULT_NAME`| folder name | App title shown in the sidebar |
+
+### Config file
+
+Place a `silmaril.yml` (or `silmaril.yaml`) in the working directory:
+
+```yaml
+vault: /path/to/vault
+host: 0.0.0.0
+port: 8000
+title: My Vault
+
+favicon: https://example.com/icon.png
+custom_css: "body { font-size: 18px; }"
+pinch_zoom: true
+readonly: false
+hide:
+  - "_private/**"
+  - "*.tmp"
+```
+
+**Priority**: CLI args > config file > environment variables > defaults.
+
+## Authentication
+
+No built-in auth. Recommended options:
+
+1. **Cloudflare Access / Tunnel** — zero-trust, recommended for public hosting
+2. **Reverse proxy with basic auth** — nginx, caddy
+3. **Run locally** — `silmaril --host 127.0.0.1`
+
+## Deployment
+
+### systemd
+
+```ini
+[Unit]
+Description=Silmaril
+After=network.target
+
+[Service]
+ExecStart=silmaril --vault /path/to/vault --port 8000
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### Docker
+
+```dockerfile
+FROM python:3.12-slim
+WORKDIR /app
+COPY pyproject.toml app.py ./
+COPY silmaril/ silmaril/
+RUN pip install --no-cache-dir .
+EXPOSE 8000
+CMD ["silmaril", "--vault", "/vault"]
+```
+
+```bash
+docker run -v /path/to/vault:/vault -p 8000:8000 silmaril
+```
+
+## License
+
+[MIT](LICENSE)
+
+## Credits
+
+Inspired by [notion4ever](https://github.com/MerkulovDaniil/notion4ever). Built with [FastAPI](https://fastapi.tiangolo.com/), [python-frontmatter](https://github.com/eyeseast/python-frontmatter), and [KaTeX](https://katex.org/).
+
+Author: [Daniil Merkulov](https://github.com/MerkulovDaniil)

silmaril-0.1.0/README.md

@@ -0,0 +1,150 @@
+# Silmaril
+
+A self-hosted, mobile-first web UI for browsing and editing Obsidian vaults from any device. Single Python file, zero config. Inspired by [notion4ever](https://github.com/MerkulovDaniil/notion4ever).
+
+```mermaid
+graph LR
+    V[("📂 Your Vault")] --- S{{"⚡ silmaril"}}
+    S <-->|browse| P["📱 Phone"]
+    S <-->|search| D["🖥️ Desktop"]
+    S <-->|edit| L["💻 Laptop"]
+```
+
+> **Your vault stays in one place. You access it from anywhere.**
+
+## Why?
+
+If your vault lives on a VPS or a desktop machine and you want to access it from your phone or any browser — this is for you. All my attempts to sync vaults across devices (Remotely Save, third-party sync plugins) kept failing with conflicts and silent data loss. Obsidian Sync works, but costs money and requires the app on every device.
+
+Silmaril takes a different approach: **your vault stays in one place, you access it from anywhere**. Point it at a directory, open a URL — browse, search, edit. It just works.
+
+It renders most of what Obsidian renders: wiki-links, embeds, callouts, KaTeX math, frontmatter properties, cover images, Bases, Iconic plugin icons. It won't replace Obsidian for heavy workflows with lots of plugins or complex Dataview queries, but for reading, quick edits, and staying on top of your notes from a phone — it's a lifesaver.
+
+## Features
+
+- **Markdown rendering** with full Obsidian flavor: `[[wiki-links]]`, `![[embeds]]`, callouts, highlights, checkboxes
+- **KaTeX** math rendering (`$inline$` and `$$display$$`)
+- **Obsidian Bases** (`.base` files) with cards, list, and table views
+- **Iconic plugin** support with native icon editing (Lucide + emoji picker)
+- **Cover images** from frontmatter (`banner`, `cover`, `image`)
+- **Frontmatter badges** (status, tags) with color coding
+- **Full-text search** with instant sidebar filtering and content snippets
+- **Cards / List / Table views** for any directory
+- **Clean URLs** — `/notes/ideas.md` not `/view/notes/ideas.md`
+- **Mobile-first** responsive design
+- **Edit and delete** notes in the browser (`?edit`, `?raw`)
+- **Code blocks** with copy button
+- **File tree** sidebar with collapsible folders
+
+## Installation
+
+```bash
+pip install silmaril
+```
+
+Then run:
+
+```bash
+silmaril --vault /path/to/your/vault
+```
+
+Open [http://localhost:8000](http://localhost:8000) in your browser.
+
+### From source
+
+```bash
+git clone https://github.com/MerkulovDaniil/silmaril.git
+cd silmaril
+pip install .
+silmaril --vault /path/to/your/vault
+```
+
+Or run directly without installing:
+
+```bash
+pip install fastapi uvicorn python-frontmatter markdown pyyaml
+python app.py --vault /path/to/vault
+```
+
+## Configuration
+
+### CLI arguments
+
+| Argument  | Env variable | Default     | Description                    |
+|-----------|-------------|-------------|--------------------------------|
+| `--vault` | `VAULT_ROOT`| `./vault`   | Path to your Obsidian vault    |
+| `--host`  | `VAULT_HOST`| `0.0.0.0`   | Bind address                   |
+| `--port`  | `VAULT_PORT`| `8000`      | Bind port                      |
+| `--title` | `VAULT_NAME`| folder name | App title shown in the sidebar |
+
+### Config file
+
+Place a `silmaril.yml` (or `silmaril.yaml`) in the working directory:
+
+```yaml
+vault: /path/to/vault
+host: 0.0.0.0
+port: 8000
+title: My Vault
+
+favicon: https://example.com/icon.png
+custom_css: "body { font-size: 18px; }"
+pinch_zoom: true
+readonly: false
+hide:
+  - "_private/**"
+  - "*.tmp"
+```
+
+**Priority**: CLI args > config file > environment variables > defaults.
+
+## Authentication
+
+No built-in auth. Recommended options:
+
+1. **Cloudflare Access / Tunnel** — zero-trust, recommended for public hosting
+2. **Reverse proxy with basic auth** — nginx, caddy
+3. **Run locally** — `silmaril --host 127.0.0.1`
+
+## Deployment
+
+### systemd
+
+```ini
+[Unit]
+Description=Silmaril
+After=network.target
+
+[Service]
+ExecStart=silmaril --vault /path/to/vault --port 8000
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### Docker
+
+```dockerfile
+FROM python:3.12-slim
+WORKDIR /app
+COPY pyproject.toml app.py ./
+COPY silmaril/ silmaril/
+RUN pip install --no-cache-dir .
+EXPOSE 8000
+CMD ["silmaril", "--vault", "/vault"]
+```
+
+```bash
+docker run -v /path/to/vault:/vault -p 8000:8000 silmaril
+```
+
+## License
+
+[MIT](LICENSE)
+
+## Credits
+
+Inspired by [notion4ever](https://github.com/MerkulovDaniil/notion4ever). Built with [FastAPI](https://fastapi.tiangolo.com/), [python-frontmatter](https://github.com/eyeseast/python-frontmatter), and [KaTeX](https://katex.org/).
+
+Author: [Daniil Merkulov](https://github.com/MerkulovDaniil)

silmaril-0.1.0/app.py

@@ -0,0 +1,5 @@
+"""Thin wrapper so ``python app.py`` keeps working."""
+from silmaril import app, main  # noqa: F401
+
+if __name__ == "__main__":
+    main()

silmaril-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "silmaril"
+version = "0.1.0"
+description = "Self-hosted, mobile-first web UI for browsing and editing Obsidian vaults"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.10"
+authors = [
+    { name = "Daniil Merkulov", email = "bratishka.mipt@gmail.com" },
+]
+keywords = ["obsidian", "vault", "viewer", "markdown", "notes", "self-hosted"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: FastAPI",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Text Processing :: Markup :: Markdown",
+]
+dependencies = [
+    "fastapi>=0.100.0",
+    "uvicorn>=0.20.0",
+    "python-frontmatter>=1.0.0",
+    "markdown>=3.4",
+    "pyyaml>=6.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/MerkulovDaniil/silmaril"
+Repository = "https://github.com/MerkulovDaniil/silmaril"
+
+[project.scripts]
+silmaril = "silmaril:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["silmaril*"]
+
+[tool.setuptools.package-data]
+silmaril = ["static/*"]

silmaril-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+