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 thread in the Obsidian Forum or join the Perlite Discord Server
- Auto build up, based on your folder (vault) structure
- Fullscreen mode
- Full responsive
- No manual parsing or converting necessary
- Full interactive Graph
- LaTeX support
- Search
- Support Obisdian links and images
(Slate)
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.
- web server, tested with
- php-fpm, tested with
- php module mb_strings for the parsedown (apt install php-mbstring)
- in the options
Files & Linksyou need to set theNew link formattoRelative path to file
- for the Graph you need to install the plugin Metadata Extractor, you can do this via the build in Community Plugin Browser
- make sure to turn on the plugin
- in the settings set the path of the metadata.json to your local vault root folder (like
C:\Users\John\MyNotes\metadata.json, when your vault is MyNotes). if you transfer your vault later to a webserver, make sure the metadata.json will be transferred too. - also dont forget set a timer how often the file should be written or just enable
Write JSON files automatically when Obsidian launches
- 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
you can adjust them via the index.php
- 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)
The Graph is implemented with vis.js, so there are many options you can play on with, you can adjust them via the options object in the perlite.js
if you want to change or specify the root directory of you vault you can do this by changing the variable $rootDir in the helper.php
- there is a pythonParser.py to genereate the vis.js JSON structure out of the metadata.json. This script is not beeing used anymore but i will let it here.
- 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.
Wiki: Perlite is an amorphous volcanic glass ... typically formed by the hydration of obsidian.