# markdown-node-cli

**Repository Path**: suzhidong/markdown-node-cli

## Basic Information

- **Project Name**: markdown-node-cli
- **Description**: 一个markdown打开cli工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-19
- **Last Updated**: 2026-01-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Nodejs, Express, Cli

## README

# Markdown Doc Server CLI

一个简单而强大的 CLI 工具，用于在浏览器中浏览和查看本地 Markdown 文件。它将目录作为树形结构提供服务，并即时渲染 Markdown 文件，类似于本地文档站点。

## 功能特性

- 📂 **树形视图导航**：根据目录结构自动生成侧边栏导航树。
- 📝 **Markdown 渲染**：即时将 Markdown 文件渲染为 HTML。
- 🖼️ **图片支持**：正确解析 Markdown 文件中的相对路径图片。
- 🚀 **零配置**：只需在文件夹中运行命令即可。
- 📦 **NPM 包**：支持全局安装或通过 npx 使用。

## 安装指南

### 全局安装

你可以使用 npm 全局安装此工具：

```bash
npm install -g markdown-node-cli
```

### 本地使用

或者直接使用 `npx` 运行：

```bash
npx markdown-node-cli
```

## 使用方法

1. 打开终端或命令提示符。
2. 导航到包含 Markdown 笔记的目录。
3. 运行命令：

```bash
doc-server
```

这将启动一个本地服务器（默认端口：`3000`）并自动打开默认浏览器。

### 选项参数

| 选项     | 别名 | 描述           | 默认值   |
| -------- | ---- | -------------- | -------- |
| `--port` | `-p` | 服务器运行端口 | `3000`   |
| `--dir`  | `-d` | 要服务的目录   | 当前目录 |

**示例：**

在端口 8080 上服务特定目录：

```bash
doc-server -d "D:\study-notes\Python" -p 8080
```

## 开发指南

1. 克隆仓库：

   ```bash
   git clone <repository-url>
   cd markdown-node-cli
   ```

2. 安装依赖：

   ```bash
   npm install
   ```

3. 本地链接包进行测试：

   ```bash
   npm link
   ```

4. 运行工具：
   ```bash
   doc-server
   ```

## 许可证

ISC