Perlite
A web based markdown viewer optimized for Obsidian Notes
Just put your hole Obsidian vault or markdown folder/file structure in your web directory. The Page will built up by it self.
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 thread in the Obsidian Forum.
Demo
Features
- auto build up, based on folder structure
- Fullscreen mode
- Full responsive
- Search
- Support Obisdian links and images
- Dark and light mode
(Darkly and Flatly)
Changelog
Install
Just put the content of the perlite directory in your web root directory, your notes should resident as a subfolder of perlite
for Docker just check the DOCKER readme.
requirements
- web server, tested with
- php-fpm, tested with
- php module mb_strings for the parsedown (apt install php-mbstring)
Images, Links and Hide Folders
- if you want to exclude specific folders, e.g. your attachment folder you can set the
HIDE_FOLDERSvariable - folders and files starting with a "." (dot) are exclude by default
In Obsidian, in the Options Files & Links you need to set the New link format to Relative path to file
Header
is not dynamic at the moment, you need to adjust them into the .php files.
- The About opens a .md file in a modal window (.about.md per default), you can change this in the helper.php
$about - The Logo, Blog and so on are nested in the index.php (line 28 e.g. for the link to the Blog)
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 renderd by browser
Why Perlite?
Wiki: Perlite is an amorphous volcanic glass ... typically formed by the hydration of obsidian.