From f3ab34a175194c03ae6174c029b674cbb10f0449 Mon Sep 17 00:00:00 2001 From: Rui-Sun Date: Mon, 8 Dec 2025 20:21:01 +0800 Subject: [PATCH] docs: update README files with detailed table of contents --- README.md | 24 ++++++++++++++++++++++++ README.zh-CN.md | 22 ++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/README.md b/README.md index 2590aea..40afdca 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,36 @@ English | [简体中文](./README.zh-CN.md) ## Table of Contents +- [Table of Contents](#table-of-contents) - [Features](#features) - [Chart Output Formats](#chart-output-formats) - [Common Parameters Supported by All Charts](#common-parameters-supported-by-all-charts) - [Supported Chart Types and Tools](#supported-chart-types-and-tools) + - [`generate_cartesian_chart`](#generate_cartesian_chart) + - [`generate_polar_chart`](#generate_polar_chart) + - [`generate_hierarchical_chart`](#generate_hierarchical_chart) + - [`generate_progress_chart`](#generate_progress_chart) + - [`generate_wordcloud_venn`](#generate_wordcloud_venn) + - [`generate_range_column_chart`](#generate_range_column_chart) + - [`generate_dual_axis_chart`](#generate_dual_axis_chart) + - [`generate_scatter_chart`](#generate_scatter_chart) + - [`generate_sankey_chart`](#generate_sankey_chart) + - [`generate_heatmap_chart`](#generate_heatmap_chart) - [Usage](#usage) + - [MacOS](#macos) + - [Windows](#windows) + - [Installing via Smithery](#installing-via-smithery) - [Running with SSE or Streamable Transport](#running-with-sse-or-streamable-transport) + - [Install and Start](#install-and-start) + - [Other CLI Options](#other-cli-options) - [Example Usage in AI Conversations](#example-usage-in-ai-conversations) - [Development](#development) + - [Prerequisites](#prerequisites) + - [Build](#build) + - [Development Mode (Auto Rebuild)](#development-mode-auto-rebuild) + - [Testing](#testing) + - [Debugging](#debugging) + - [Testing in AI Editors](#testing-in-ai-editors) - [Environment Variables](#environment-variables) - [Private Deployment](#private-deployment) - [License](#license) @@ -499,6 +521,8 @@ Currently, images and HTML generated by vchart-mcp-server are produced via [http } ``` +Image generation service can be deployed privately refer to https://github.com/VisActor/vchart-mcp-server-export. + ## License MIT License diff --git a/README.zh-CN.md b/README.zh-CN.md index c686218..7d69c7d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -29,16 +29,36 @@ ## 目录 +- [目录](#目录) - [功能特性](#功能特性) - [图表输出格式](#图表输出格式) - [所有图表都支持的公共参数](#所有图表都支持的公共参数) - [支持的图表类型和工具](#支持的图表类型和工具) + - [`generate_cartesian_chart`](#generate_cartesian_chart) + - [`generate_polar_chart`](#generate_polar_chart) + - [`generate_hierarchical_chart`](#generate_hierarchical_chart) + - [`generate_progress_chart`](#generate_progress_chart) + - [`generate_wordcloud_venn`](#generate_wordcloud_venn) + - [`generate_range_column_chart`](#generate_range_column_chart) + - [`generate_dual_axis_chart`](#generate_dual_axis_chart) + - [`generate_scatter_chart`](#generate_scatter_chart) + - [`generate_sankey_chart`](#generate_sankey_chart) + - [`generate_heatmap_chart`](#generate_heatmap_chart) - [使用方法](#使用方法) + - [MacOS](#macos) + - [Windows 系统](#windows-系统) + - [通过 Smithery 安装](#通过-smithery-安装) - [使用SSE或Streamable传输方式运行](#使用sse或streamable传输方式运行) - [安装与启动](#安装与启动) - [其他CLI配置](#其他cli配置) - [AI 对话中的使用示例](#ai-对话中的使用示例) - [开发](#开发) + - [先决条件](#先决条件) + - [构建](#构建) + - [开发模式(自动重建)](#开发模式自动重建) + - [测试](#测试) + - [调试](#调试) + - [在AI编辑器中测试](#在ai编辑器中测试) - [环境变量](#环境变量) - [私有化开发](#私有化开发) - [许可证](#许可证) @@ -499,6 +519,8 @@ npm run inspector } ``` +图像生成服务可以参考 https://github.com/VisActor/vchart-mcp-server-export 来私有化部署。 + ## 许可证 MIT 许可证