Perlite
Display your Obsidian notes online with a dedicated web viewer. Explore connections with an interactive graph, customize the appearance, and share your knowledge.
Perlite is a web-based markdown viewer specifically designed to publish and display your Obsidian notes online. It transforms your local vault into a navigable website, making it easy to share your knowledge base with others or access it from any device with a browser.
The standout feature is its interactive graph view, which visually maps the connections between your notes. You can explore relationships through links and tags, customize the graph's appearance, and identify orphaned notes. This provides a powerful way to understand the structure of your thoughts.
Perlite offers a high degree of compatibility with core Obsidian features, ensuring your notes look just right:
- Support for callouts, frontmatter, and tags.
- Renders complex elements like LaTeX equations and Mermaid diagrams.
- Correctly handles internal links, backlinks, and embedded content.
You can also customize the viewing experience with different themes, a dark mode, and adjustable font sizes. It's an excellent tool for anyone looking to publish their digital garden, share research, or simply have a read-only version of their vault accessible on the web.
Directory Structure
docker-compose.yml
services:
perlite:
image: secure77/perlite:latest
container_name: perlite
ports:
- "80:80"
volumes:
- ./Obsidian:/var/www/perlite/Obsidian
environment:
- NOTES_DIR=Obsidian
- SITE_TITLE=Perlite
- HIDE_FOLDERS=.obsidian,.git,.trash
restart: unless-stopped.env
# Perlite does not require sensitive credentials by default.
# If you add a reverse proxy with Basic Auth, you can store those secrets here.Tags:
Similar to Perlite