← Back to Skills Marketplace
Md Viewer
by
hoangcongst
· GitHub ↗
· v1.0.2
· MIT-0
117
Downloads
0
Stars
0
Active Installs
2
Versions
Install in OpenClaw
/install md-viewer
Description
LAN-accessible web viewer for Markdown files optimized for e-readers. Auto-binds to LAN IP for easy access. TRIGGER when user says "cho tôi xem", "show me",...
Usage Guidance
This skill appears to be what it claims: a local LAN web viewer for .md files. Before installing, consider these practical security/privacy points:
- Network exposure: the default behavior auto-binds to your LAN IP and opens a listening port (8765). Only run on trusted networks or use the --localhost option to restrict to loopback.
- URL tokens: links include the password/token in the URL. Tokens in URLs can leak via browser referrers, logs, or chat messages. Treat links as sensitive and avoid sharing on untrusted systems.
- Cookie lifetime & auth: the cookie is persistent (30 days). If someone can access the browser on a device that opened the link, they may gain access until the cookie expires.
- History file: the server stores a history file (~/.md-viewer-history.json) that may include names/paths of viewed files. Use --no-history if you prefer not to persist that.
- Path checks: the code blocks common sensitive paths/patterns, but path-blocking is based on string checks. If you have concerns, review server.py to confirm it resolves symlinks and enforces absolute paths before serving.
- Sanitization: the code prefers bleach for sanitization; if bleach is not installed, it falls back to regex-based sanitization which is less robust. Install bleach (pip3 install bleach) to improve XSS protection.
If you want to minimize risk: run with --localhost, use a strong custom password (--password), disable history (--no-history), and keep bleach installed. Review the bundled server.py yourself if you handle sensitive files.
Capability Assessment
Purpose & Capability
Name/description match what the code and SKILL.md do: a local web server that renders .md files and generates LAN links. No unrelated credentials, binaries, or cloud services are requested.
Instruction Scope
SKILL.md instructs the agent to start a local server and generate LAN links rather than reading/summarizing file contents — this matches the code. The server necessarily reads markdown files to serve them (expected), but the skill does not instruct the agent to collect or transmit unrelated system data. Be aware the agent will instruct the local system to run a network-facing server.
Install Mechanism
No remote installers or downloads are used; code is bundled in the skill and dependencies are typical Python packages (markdown, bleach). No high-risk install URLs or archive extraction are present.
Credentials
The skill requests no environment variables or external credentials. It stores history to a file in the user's home directory and uses a generated password/token to protect access — these are proportionate and expected for its functionality.
Persistence & Privilege
always:false (no forced installation). The server writes a history file (~/.md-viewer-history.json) and creates a long-lived cookie (30 days) for convenience. It also binds to a LAN IP by default (network exposure), which is necessary for sharing but is a privileged network-facing behaviour to be aware of.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install md-viewer - After installation, invoke the skill by name or use
/md-viewer - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.2
md-viewer 1.0.2
- Server now auto-binds to LAN IP for easier network access.
- Password authentication upgraded: supports cookie-based login (30 days), enabling seamless future access.
- Viewer theme and font optimized for e-reader comfort (light theme, high contrast, serif fonts).
- Improved security: HTML sanitized with bleach library and enhanced blocked path list.
- Simplified sharing: access links contain token, with password auto-saved on first use.
- New server options allow easier LAN/localhost selection and disabling history for privacy.
- Added VERSION.md.
v1.0.1
- Adds a Markdown web viewer skill accessible via LAN, letting users open .md files directly in their browser from any device on the same WiFi.
- Triggers when the user requests to view/review a Markdown file (in English or Vietnamese).
- Enforces security: only allows .md files, blocks sensitive paths, password protects access, and sanitizes output to prevent XSS.
- Provides simple commands to start the server and generate secure viewing links.
- Mobile-friendly, features GitHub-style dark mode and syntax highlighting for Markdown files.
Metadata
Frequently Asked Questions
What is Md Viewer?
LAN-accessible web viewer for Markdown files optimized for e-readers. Auto-binds to LAN IP for easy access. TRIGGER when user says "cho tôi xem", "show me",... It is an AI Agent Skill for Claude Code / OpenClaw, with 117 downloads so far.
How do I install Md Viewer?
Run "/install md-viewer" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Md Viewer free?
Yes, Md Viewer is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Md Viewer support?
Md Viewer is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Md Viewer?
It is built and maintained by hoangcongst (@hoangcongst); the current version is v1.0.2.
More Skills