# MarkdownView

**Repository Path**: xaek/markdown-view

## Basic Information

- **Project Name**: MarkdownView
- **Description**: 一个纯前端单文件的 Markdown 查看器：直接打开 index.html，导入或拖拽 .md/.markdown 文件即可预览，并在左侧显示目录（优先复用文档内已有“目录”区块，否则自动从标题生成）。
- **Primary Language**: HTML
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-15
- **Last Updated**: 2026-01-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# markdown-view

一个**纯前端单文件**的 Markdown 查看器：直接打开 `index.html`，导入或拖拽 `.md/.markdown` 文件即可预览，并在左侧显示目录（优先复用文档内已有“目录”区块，否则自动从标题生成）。

## 功能

- 导入文件：点击“导入 .md”或将文件拖入页面任意位置
- 渲染：CommonMark + 常见扩展（任务列表、脚注、emoji、标题锚点）
- 目录：固定侧边栏；支持平滑滚动跳转
- 离线降级：若无法访问 CDN（离线/网络策略限制），会自动以纯文本方式展示内容

## 使用方式

### 方式 1：直接打开

1. 双击打开 `index.html`（或在浏览器中打开该文件）
2. 点击“导入 .md”，或将 Markdown 文件拖入页面

> 注：某些浏览器/组织策略可能限制本地文件访问网络 CDN。此时页面会自动降级为纯文本展示。

### 方式 2：本地起一个静态服务器（推荐）

使用任意静态服务器都可以，例如：

- Python：
  - `python -m http.server 8080`
- Node.js（已安装 npx）：
  - `npx serve .`

然后在浏览器访问 `http://localhost:8080`（或对应端口）。

## 示例文件

- `markdown-all-syntax.md`：尽量覆盖常见 Markdown/GFM 扩展语法，用于渲染测试。

## 许可

本项目使用 MIT 许可证，详见 `LICENSE`。