Skip to content

Commit d07734a

Browse files
authored
Merge pull request #5 from VisActor/chore/update_README
docs: update README files with detailed table of contents
2 parents 28283c9 + f3ab34a commit d07734a

2 files changed

Lines changed: 46 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,36 @@ English | [简体中文](./README.zh-CN.md)
3030

3131
## Table of Contents
3232

33+
- [Table of Contents](#table-of-contents)
3334
- [Features](#features)
3435
- [Chart Output Formats](#chart-output-formats)
3536
- [Common Parameters Supported by All Charts](#common-parameters-supported-by-all-charts)
3637
- [Supported Chart Types and Tools](#supported-chart-types-and-tools)
38+
- [`generate_cartesian_chart`](#generate_cartesian_chart)
39+
- [`generate_polar_chart`](#generate_polar_chart)
40+
- [`generate_hierarchical_chart`](#generate_hierarchical_chart)
41+
- [`generate_progress_chart`](#generate_progress_chart)
42+
- [`generate_wordcloud_venn`](#generate_wordcloud_venn)
43+
- [`generate_range_column_chart`](#generate_range_column_chart)
44+
- [`generate_dual_axis_chart`](#generate_dual_axis_chart)
45+
- [`generate_scatter_chart`](#generate_scatter_chart)
46+
- [`generate_sankey_chart`](#generate_sankey_chart)
47+
- [`generate_heatmap_chart`](#generate_heatmap_chart)
3748
- [Usage](#usage)
49+
- [MacOS](#macos)
50+
- [Windows](#windows)
51+
- [Installing via Smithery](#installing-via-smithery)
3852
- [Running with SSE or Streamable Transport](#running-with-sse-or-streamable-transport)
53+
- [Install and Start](#install-and-start)
54+
- [Other CLI Options](#other-cli-options)
3955
- [Example Usage in AI Conversations](#example-usage-in-ai-conversations)
4056
- [Development](#development)
57+
- [Prerequisites](#prerequisites)
58+
- [Build](#build)
59+
- [Development Mode (Auto Rebuild)](#development-mode-auto-rebuild)
60+
- [Testing](#testing)
61+
- [Debugging](#debugging)
62+
- [Testing in AI Editors](#testing-in-ai-editors)
4163
- [Environment Variables](#environment-variables)
4264
- [Private Deployment](#private-deployment)
4365
- [License](#license)
@@ -499,6 +521,8 @@ Currently, images and HTML generated by vchart-mcp-server are produced via [http
499521
}
500522
```
501523

524+
Image generation service can be deployed privately refer to https://github.com/VisActor/vchart-mcp-server-export.
525+
502526
## License
503527

504528
MIT License

README.zh-CN.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,36 @@
2929

3030
## 目录
3131

32+
- [目录](#目录)
3233
- [功能特性](#功能特性)
3334
- [图表输出格式](#图表输出格式)
3435
- [所有图表都支持的公共参数](#所有图表都支持的公共参数)
3536
- [支持的图表类型和工具](#支持的图表类型和工具)
37+
- [`generate_cartesian_chart`](#generate_cartesian_chart)
38+
- [`generate_polar_chart`](#generate_polar_chart)
39+
- [`generate_hierarchical_chart`](#generate_hierarchical_chart)
40+
- [`generate_progress_chart`](#generate_progress_chart)
41+
- [`generate_wordcloud_venn`](#generate_wordcloud_venn)
42+
- [`generate_range_column_chart`](#generate_range_column_chart)
43+
- [`generate_dual_axis_chart`](#generate_dual_axis_chart)
44+
- [`generate_scatter_chart`](#generate_scatter_chart)
45+
- [`generate_sankey_chart`](#generate_sankey_chart)
46+
- [`generate_heatmap_chart`](#generate_heatmap_chart)
3647
- [使用方法](#使用方法)
48+
- [MacOS](#macos)
49+
- [Windows 系统](#windows-系统)
50+
- [通过 Smithery 安装](#通过-smithery-安装)
3751
- [使用SSE或Streamable传输方式运行](#使用sse或streamable传输方式运行)
3852
- [安装与启动](#安装与启动)
3953
- [其他CLI配置](#其他cli配置)
4054
- [AI 对话中的使用示例](#ai-对话中的使用示例)
4155
- [开发](#开发)
56+
- [先决条件](#先决条件)
57+
- [构建](#构建)
58+
- [开发模式(自动重建)](#开发模式自动重建)
59+
- [测试](#测试)
60+
- [调试](#调试)
61+
- [在AI编辑器中测试](#在ai编辑器中测试)
4262
- [环境变量](#环境变量)
4363
- [私有化开发](#私有化开发)
4464
- [许可证](#许可证)
@@ -499,6 +519,8 @@ npm run inspector
499519
}
500520
```
501521

522+
图像生成服务可以参考 https://github.com/VisActor/vchart-mcp-server-export 来私有化部署。
523+
502524
## 许可证
503525

504526
MIT 许可证

0 commit comments

Comments
 (0)