Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/secure-77/Perlite

A web-based markdown viewer optimized for Obsidian
https://github.com/secure-77/Perlite

markdown obsidian parsedown perlite

Last synced: about 7 hours ago
JSON representation

A web-based markdown viewer optimized for Obsidian

Host: GitHub
URL: https://github.com/secure-77/Perlite
Owner: secure-77
License: mit
Created: 2021-05-29T14:12:36.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-09-24T09:34:38.000Z (about 2 months ago)
Last Synced: 2024-10-29T15:24:26.064Z (10 days ago)
Topics: markdown, obsidian, parsedown, perlite
Language: CSS
Homepage: https://perlite.secure77.de/
Size: 72.8 MB
Stars: 1,091
Watchers: 11
Forks: 98
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

project-awesome - secure-77/Perlite - A web-based markdown viewer optimized for Obsidian (CSS)
jimsghstars - secure-77/Perlite - A web-based markdown viewer optimized for Obsidian (CSS)
awesome-obsidian - Perlite - 77](https://github.com/secure-77) (Publishing)

README

        # Perlite

  

![GitHub release (latest by date)](https://img.shields.io/github/v/release/secure-77/perlite) ![GitHub](https://img.shields.io/github/license/secure-77/perlite) ![GitHub last commit](https://img.shields.io/github/last-commit/secure-77/Perlite)

A web based markdown viewer optimized for [Obsidian](https://obsidian.md/) 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  [obsidian publish](https://obsidian.md/publish).

Read more about Perlite and staging tips on my blog post: [Perlite on Secure77](https://secure77.de/perlite).

If you want to discuss Perlite you can join the [Perlite Discord Server](https://discord.gg/pkJ347ssWT)

## Demo

[Perlite Demo](https://perlite.secure77.de/)

![Demo Screenshot](https://raw.githubusercontent.com/secure-77/Perlite/main/screenshots/screenshot.png "Demo Screenshot")

![Graph Screenshot](https://raw.githubusercontent.com/secure-77/Perlite/main/screenshots/graph.png "Graph Screenshot")

## Features

- Auto build up, based on your folder (vault) structure

- No Database required

- Obsidian Themes Support

- Fully Responsive

- No manual parsing or converting necessary

- Full interactive Graph

- LaTeX and Mermaid Support

- Link to Obsidian Vault

- Search

- Obsidian tags, links, images and preview Support

- Dark and Light Mode

## Install

Please make sure you read the [required settings](https://github.com/secure-77/Perlite/wiki/03---Perlite-Settings#required-settings) first!

You can download the latest release from github or git clone the project and use docker.

- For non Docker please check [Setup](https://github.com/secure-77/Perlite/wiki/01---Setup-(no-Docker))

- For Docker, please check [Docker Setup](https://github.com/secure-77/Perlite/wiki/02---Setup-Docker)

## Wiki

Please check the [wiki](https://github.com/secure-77/Perlite/wiki), here you will find further information, for example:

- [Themes](https://github.com/secure-77/Perlite/wiki/Themes)

- [Graph Setup and Settings](https://github.com/secure-77/Perlite/wiki/Graph)

- [Perlite Settings](https://github.com/secure-77/Perlite/wiki/03---Perlite-Settings)

- [Troubleshooting](https://github.com/secure-77/Perlite/wiki/Troubleshooting)

## Security

- The [Safemode](https://github.com/erusev/parsedown#security) 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.

## Contributing

Want to contribute? Awesome! Please use the [dev branch](https://github.com/secure-77/Perlite/tree/dev) for pull requests.

## Why Perlite?

[Wiki](https://en.wikipedia.org/wiki/Perlite):

*Perlite is an amorphous volcanic glass ... typically formed by the hydration of obsidian.*

## Previous Versions and Changelog

- [Changelog](https://github.com/secure-77/Perlite/blob/main/Changelog.md)

- [Perlite 1.4.4 Demo](https://perlite.secure77.de/1.4.4)

- [Perlite 1.3 Demo](https://perlite.secure77.de/1.3)