Skip to content

PCI-Statmonkey/vault-viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

=== Vault Viewer ===
Contributors: statmonkey
Tags: obsidian, markdown, notes, viewer, knowledgebase
Requires at least: 6.0
Tested up to: 6.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

== Description ==
Vault Viewer is a read-only Obsidian-style Markdown vault viewer for WordPress.

It allows site admins to upload Obsidian vault folders (ZIP),
browse notes with internal links, tables, images, and colored text,
and optionally open the vault in a full-screen "app mode" reader.

No editing. No CLI. No external services.

== Features ==
* Read-only Obsidian vault display
* Wiki links ([[Note]] and [[Note|Alias]])
* Tables (GitHub-style)
* Images and embeds
* Colored text via inline spans
* Dark / Light mode toggle
* Fullscreen App Mode (?vv=app)
* Per-vault state persistence (last note, folder state)
* Admin-only uploads

== Installation ==
1. Upload the plugin ZIP via WordPress Admin
2. Activate the plugin
3. Create a new Vault
4. Upload a ZIP of your Obsidian notes

== FAQ ==
= Can visitors edit notes? =
No. Viewer is strictly read-only.

= Does this require Obsidian installed? =
No. Only Markdown files.

== Changelog ==
= 1.0.0 =
Initial release.

== Troubleshooting ==

= Vault page shows “Failed to load index.” =
This means the vault files were not extracted or the index file could not be read.

Most commonly, this is caused by missing server support for ZIP extraction.

=== 1. PHP Zip extension is required ===
Vault Viewer uploads ZIP files and extracts them on the server.

On many shared hosts, the PHP `zip` extension is NOT enabled by default.

How to check:
- WordPress Admin → Tools → Site Health → Info → Server
- Look for `zip` under PHP Extensions

Or via cPanel:
- Select PHP Version / PHP Extensions
- Ensure `zip` is enabled

After enabling the zip extension, re-upload the vault ZIP.

---

=== 2. Verify files were extracted ===
Using cPanel File Manager or SFTP, check:


wp-content/uploads/vault-viewer/<vault-slug>/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors