# mdViewer

**Repository Path**: iam17/mdViewer

## Basic Information

- **Project Name**: mdViewer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-27
- **Last Updated**: 2026-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# md-viewer

本地 Markdown 文档浏览器：输入 `.md` 文件的绝对路径，在浏览器中渲染预览。

## 功能

- 输入文件的绝对路径并加载。
- 以渲染后的 Markdown（GFM 语法）展示内容。

## 安装

```bash
cd /Users/dhw/f/md-viewer
npm install
```

## 启动

```bash
npm start
```

启动后终端会输出：

```
md-viewer running at http://localhost:4321
```

在浏览器中打开 [http://localhost:4321](http://localhost:4321) 即可使用。

## 使用方法

1. 打开页面。
2. 在左侧输入要查看的 `.md` 文件绝对路径，例如 `/Users/dhw/f/project/README.md`。
3. 点击“打开”或按回车，右侧主区域会加载并渲染该文件内容。

## 配置项

- **端口**：默认 `4321`，可通过环境变量 `PORT` 修改，例如：

  ```bash
  PORT=8080 npm start
  ```

## 注意事项

- 该服务只读取 `.md` 文件内容用于展示，不提供编辑、保存功能。
- 接口 `/api/file` 只接受 `.md` 文件的绝对路径。
- 该服务仅设计用于本机本地使用，未做鉴权，请勿暴露到公网。