# markdown-toc

**Repository Path**: RanGuMo/markdown-toc

## Basic Information

- **Project Name**: markdown-toc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-23
- **Last Updated**: 2025-09-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown TOC 查看器

一个基于 Vue 3 + Vite 的 Markdown 文档查看器 Demo，支持自动生成目录。

## 功能特性

- 📖 Markdown 内容渲染
- 📑 自动提取标题生成目录
- 🎨 代码语法高亮
- 🎯 点击目录跳转到对应章节
- 📱 响应式布局

## 技术栈

- Vue 3 + Vite
- marked (Markdown 解析)
- highlight.js (代码高亮)
- github-markdown-css (样式)

## 快速开始

```bash
# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建
npm run build
```

## 项目结构

```
src/
├── components/
│   └── MarkdownWithToc.vue  # 主组件
├── App.vue                  # 根组件
└── main.js                  # 入口文件
```

## 使用方法

```vue
<template>
  <MarkdownWithToc :markdownContent="markdownContent" />
</template>

<script setup>
import MarkdownWithToc from './components/MarkdownWithToc.vue'
import { ref } from 'vue'

const markdownContent = ref('# 标题\n内容...')
</script>
```

---

这是一个简单的 Demo 项目，用于演示 Markdown 文档查看和目录生成功能。