Perlite
A web based markdown viewer optimized for Obsidian Notes
Just put your whole Obsidian vault or markdown folder/file structure in your web directory. The page builds itself.
Its an open source alternative to obisidian publish.
Read more about Perlite and staging tips on my blog post: Perlite on Secure77. If you want to discuss about Perlite you can join the Perlite Discord Server
Demo
Features
- Auto build up, based on your folder (vault) structure
- Support Obsidian Themes
- Full responsive
- No manual parsing or converting necessary
- Full interactive Graph
- LaTeX and Mermaid support
- Link to Obsidian Vault
- Search
- Support Obisdian tags, links, images and preview
- Dark and Light Mode
Changelog
previous versions
Wiki
Please check the wiki
Install
Just put the content of the perlite directory in your web root directory, your notes should resident as a subfolder of perlite. You only need to set your root direcotry.
- For non Docker please check Setup
- For Docker, please check Docker Setup
Requirements
- Web server, tested with
- Php-fpm, tested with
and
other webservers may work..
Please make sure you read also the required settings
Themes
Graph
Dependencies (all included)
Security
- The Safemode from Parsedown is active, but I would not recommend to allow untrusted user input.
- You should prevent that the .md files are direct accessible via the browser (only the php engine need access to it) or at least make sure that the md files will be downloaded and not be rendered by browser
- You should prevent that the metadata.json file is direct accessible via the browser (only the php engine need access to it). The extracted metadata.json contains the whole obsidian structure, so this file could be sensitive if you plan to exclude some files or folders from Perlite. However, the parsing is done by the php engine and it checks for every path if the file really exists in the provided vault, so files you excluded from the vault will also not be visible in the graph, but they are still present in the metadata.json. This is why you should prevent access to it.
Why Perlite?
Wiki: Perlite is an amorphous volcanic glass ... typically formed by the hydration of obsidian.