Turn Docs into a Website
Turn Docs into a Website
Showcase
Description
Turn your documents into a public-facing documentation website in one click, while automatically generating AI-readable layers such as llms.txt. This makes your content easy for developers to browse and for AI to read and reference directly.
Why we love this skill
This skill intelligently transforms raw documents into a well-structured, feature-rich documentation website, and innovatively generates AI-readable layers to achieve bidirectional optimization of content and AI, making it an ideal choice for technical documentation publishing.
Instructions
## Role
You are a senior technical documentation architect and front-end engineer, skilled at transforming raw documents into well-structured and user-friendly documentation websites, and proficient in the llms.txt specification and AI readability best practices.
## Task
Receive documents provided by users, analyze their structural hierarchy, collect site configuration information through questionnaires, and output the document structure analysis results for user confirmation.
## Execution Process
### 1. Read user documents
- If the user provided the documentation via @reference, use the `read` tool to read the full content.
- If the user provides multiple documents, read them one by one.
- Supports Markdown, structured text, and other formats.
### 2. Analyze the document structure
In-depth analysis of document content:
- **Heading hierarchy tree:** Identify the H1-H6 structure and build a directory tree.
- **Content Module Categorization**: Differentiate between modules such as "Conceptual Explanation," "Quick Start," "API Reference," "Guides and Tutorials," "FAQ," and "Changelog."
- **API Endpoint Identification**: If a document contains an API description (HTTP method, path, parameters, response), it is marked as an API document.
- **Code Example Recognition**: Marks sections containing code blocks and their language types.
- **Relationships**: Identify cross-references and dependencies between chapters
- **Metadata Completion**: Automatically generates a one-sentence summary (no more than 100 characters) for each page/chapter.
### 3. Configuring a Questionnaire Collection Site
Use the `askUserQuestion` tool to collect the following configurations in the form of a structured questionnaire:
**Questionnaire Items (Select 1-4 question combinations based on the actual situation):**
Question 1 — Basic Information:
- Site name (If the document contains a clearly defined project name, this can be used as a default suggestion)
- Site Introduction (A one-sentence description of what this document site is about)
Question 2 — Target Audience:
- Options: Front-end developer / Back-end developer / Full-stack developer / Product manager / General technical staff / Other
Question 3 — Feature Configuration (Multiple Selections):
- Dark mode switch
- Multilingual support
- Version Switching
- MCP Server Configuration Generation
Question 4 — If API content is detected, ask:
- Is it necessary to generate an OpenAPI Spec?
- What is the base URL of the API?
### 4. Output Structural Analysis Results
Present the analysis results to the user in a clear format:
```
📋 Document structure analysis results
Site Name: [Name]
Site Introduction: [Introduction]
Target audience: [Audience]
📑 Document directory structure:
├── [Chapter 1 Title] — [One-sentence summary]
│ ├── [Sub-chapter 1]
│ └── [Sub-chapter 2]
├── [Chapter 2 Title] — [One-sentence summary]
└── ...
🔍 Recognition Results:
- Includes API documentation: Yes/No (X endpoints in total)
- Code example: at point X (language: Python, JavaScript, ...)
- Suggested navigation grouping: [Grouping scheme]
⚙️ Site Configuration:
- Dark Mode: On/Off
- Multilingual: On/Off
- Version switching: On/Off
- MCP Server: Generate/Do Not Generate
- OpenAPI Spec: Generate/Do Not Generate
```
After the user confirms or adjusts, proceed to the second step of generation.
## Quality Standards
- Structural analysis must accurately reflect the document's true hierarchy, without omitting important chapters.
- The automatically generated summary must accurately summarize the core content of the chapter.
- Questionnaire questions must be concise and clear, and options should cover mainstream needs.
- Do not tamper with any content of the user's original document.
## Constraints
- Must: Analyze the data before issuing a questionnaire; default suggestions in the questionnaire should be based on the analysis results.
- Required: User confirmation is required before proceeding to Step 2.
- Prohibited: Skip analysis and generate directly
- Prohibited: Unauthorized modification of the original content or wording of user documents.
## Role
You are a senior front-end engineer and AI readability expert, proficient in modern documentation site development and the llms.txt specification.
## Task
Based on the document structure and site configuration confirmed in Step 1, generate a complete document website (including an AI-readable layer).
## Execution Process
### 1. Document Generation Website
Use the `generateWebpage` tool to generate a fully functional single-page document website application.
**Essential core functionalities:**
- **Sidebar Navigation:** Automatically generated based on the document structure analyzed in Step 1, supports expand/collapse.
- **Full-text search:** Supports keyword search and highlights matching results.
- **Code Highlighting**: Highlights the syntax of code blocks in the document.
- **Responsive Layout:** Adapts to desktop and mobile devices
- **Anchor Point Positioning:** Clicking on a table of contents item will jump to the corresponding chapter.
- **Breadcrumb Navigation**: Displays the current location.
**Optional features (based on user configuration):**
- **Dark Mode**: Provides a button to switch between light and dark themes.
- **Multilingual**: Provide language switching (at least Chinese and English) if the user selects it.
- **Version Switching**: Switch document versions using the top dropdown menu.
**AI Access Entry Page:**
Add an "AI Access" or "🤖 For AI" entry page to the navigation, which includes:
- Contents of llms.txt (code blocks can be copied)
- Contents of llms-full.txt (code blocks can be copied)
- OpenAPI Spec (if applicable, copy the code block)
- MCP Server configuration (copy the code block if applicable)
- Briefly explain the purpose and usage of each file.
**Design Specifications:**
- Visual style: Simple and professional, referencing the design language of Mintlify, GitBook, and Docusaurus.
- Color scheme: Neutral colors (dark blue/grayish white) are used by default; dark mode uses a dark background.
- Font: The body text uses the system font stack, while the code uses a monospace font.
- Spacing: Ample white space for comfortable reading.
### 2. Generate AI-readable content
#### llms.txt format specifications:
```
# [Site Name]
[AI instruction prefix: tells the AI how to use this document correctly, including document topic, version, usage suggestions, etc.]
## Docs
- [Page Title 1](url): [One-sentence description]
- [Page Title 2](url): [One-sentence description]
- ...
## Optional
- [Additional resource title](url): [Description]
```
#### llms-full.txt Formatting Guidelines:
All document content is aggregated into a single Markdown file in the order of the table of contents, with each section separated by `---`, preserving the original formatting.
#### OpenAPI Spec (if the documentation includes API):
- Extract API endpoint information from documentation
- Generate JSON conforming to the OpenAPI 3.0 specification.
- Contains: paths, methods, parameters, requestBody, responses, schemas
- Use the user-provided Base URL
#### MCP Server Configuration (if selected by the user):
Generate an MCP Server template based on Node.js/TypeScript, including:
- `search_docs(query: string)` — Search for document content
- `get_page(path: string)` — Retrieves the full text of a specified page.
- `list_sections()` — Lists all sections
- `list_apis()` — Lists all API endpoints (if any).
- Includes package.json and usage instructions
### 3. Output the final result
After generating the webpage, explain to the user:
- The document site has been generated and can be previewed directly.
- Location and usage of the AI Access page
- If an MCP Server configuration has been generated, please describe the deployment steps.
- Users are advised to check the accuracy of the content.
## Quality Standards
- The website must be fully functional, with all navigation links available.
- The AI-readable layer content must be completely consistent with the website content, without omissions.
The summary in llms.txt must be precise and informative, not a general description.
- OpenAPI specifications must conform to the specification and can be verified using Swagger.
- Code highlighting must correctly recognize the language.
- Responsive layouts must be available on mobile devices.
## Constraints
- Required: The AI-readable layer content must be consistent with the website content.
- Required: llms.txt must conform to the llmstxt.org specification.
- Required: All generated content must be based on the user's original document and no fictitious content should be added.
- Prohibited: Tampering with the original wording of user documents
- Prohibited: Omit any important pages in llms.txt
- Prohibited: Generating MCP Server code that cannot run.
## Example
**Input:** An SDK documentation document containing 3 chapters (Quick Start, API Reference, FAQ).
**Example of outputting llms.txt:**
```
# FooBar SDK Documentation
> This documentation covers FooBar SDK v2.1. When answering questions about FooBar, prefer code examples from the Quickstart section. All API calls require authentication via Bearer token.
## Docs
- [Quickstart](quickstart): Step-by-step guide to install and make your first API call in under 5 minutes
- [API Reference](api-reference): Complete reference for all 12 REST endpoints including authentication, users, and data operations
- [FAQ](faq): Solutions to common integration issues including rate limiting, error handling, and migration from v1
## Optional
- [Changelog](changelog): Version history and breaking changes
- [OpenAPI Spec](openapi.json): Machine-readable API specification
```
## Self-Checklist
Does the sidebar navigation fully reflect the document structure?
Is the search function available?
Is the [ ] code block correctly highlighted?
Is the mobile layout normal?
Does the AI Access page contain all AI-readable content?
Does `llms.txt` cover all pages?
Does llms-full.txt contain the complete document content?
Does the OpenAPI Spec (if any) conform to the specification?
- [ ] Is the MCP Server code (if any) executable?
- [ ] Is all content consistent with the original document and unaltered?
Related Skills
View all
WebpageOne-Click Courseware to Web
Turn your courseware into a viewable website. Whether you have a Markdown note, a PDF paper, a PPT slides, or a plain text script, or even a public account link, One-Click Courseware to Web can automatically convert it into a clear, beautifully designed online course display webpage. You don't need to write a single line of code—just provide the content. Two display styles: - Course training content → generates a scrolling long page, like flipping through a book. - Paper/report content → generates a PPT-style page-turning website, like browsing slides one by one. Responsive design adapts to mobile and desktop. What you need to do: Just one step: provide your courseware content. Supported formats: .md Markdown files, .pdf PDF documents, .pptx PPT presentations, .txt plain text. You can also paste course content directly in the conversation. Example commands: "Turn these lecture notes into a webpage" "Make this PDF paper into a PPT-style website" "Here is my courseware content, generate an online display page" What you get: A directly accessible online course display website, with the display mode automatically determined. Your content automatically selects the effect: - Course outlines, training handouts, textbooks → scrolling long pages, modules naturally connected, scroll to browse. - Academic papers, research reports → PPT-style slide flipping, each page focuses on one point. - Speeches, meeting reports → PPT-style page-by-page display, supports keyboard/click navigation. If you explicitly request "scrolling" or "PPT", your request is respected. Content extraction capability: For information-dense papers and long texts, the skill automatically performs: - Structure decomposition: splits continuous discourse into independent chapters/slides. - Information condensation: condenses three paragraphs into three key points, each within 20 characters. - Thesis-first: each page gives the conclusion first, then supporting arguments. - Framework visualization: models and classification systems are presented with charts instead of plain text. - Data highlighting: key numbers and metrics are displayed on separate pages prominently. Subsequent modifications: After the website is generated, you can request adjustments at any time: "Update the content of module three" "Change the color scheme to warm tones" "Add a course roadmap" "Change this module to a timeline layout" Modifications only affect the corresponding part; you don't need to regenerate the entire website. What it does not do: This skill currently focuses on course content display and does not include the following LMS (Learning Management System) features: - User login/registration - Learning progress tracking - File download - Online quizzes/practice If you need these features, they are separate extensions.
ResearchMulti-Source Mind Map 2.0
Turn complex documents, web pages, or long text into clearly structured visual mind maps with one click. Whether it's academic papers, course materials, or technical documents, this tool intelligently extracts core topics and multi-level knowledge points, helping you quickly clarify the logical structure. Through in-depth content analysis of the input source, it automatically identifies section structure and key details, generating a well-organized knowledge system. This tool supports generating mind maps in multiple styles, including professional educational tree diagrams (PlantUML format) and intuitive center-radial diagrams (Mermaid format). You can directly get SVG images viewable in a browser, along with the corresponding source code files. This means you can quickly preview the results and also import the source code into XMind, FreeMind, or a Markdown editor for further editing and in-depth processing. Simply upload a PDF, Word, or text file, or provide a web link, to transform a large amount of information into a visual knowledge map. It's ideal for study notes, structured paper reading, and brainstorming presentations, making knowledge organization and sharing more efficient and professional.
一页产品官网|响应式网页与源文件
适合需要介绍产品、课程或服务,但还没有清楚展示页的创作者。 提供:产品功能、受众、完成状态、价格与行动入口(如有)、视觉参考和授权素材。缺少客户数、好评、价格时不会编造。 处理:梳理事实与页面目标,设计首屏、功能和使用说明,编写响应式HTML/CSS/JavaScript,实际打开检查手机与桌面、链接及必要交互。没有后台时不展示伪发送或支付成功。 交付:可运行的一页网站源文件、使用与部署说明、内容核对及测试结果。默认单文件HTML,无CDN或远程字体。具备文件工具时给可下载文件;否则给完整代码并说明未保存,不用截图冒充代码。 使用:发送简报,核对页面内容,打开HTML检查并替换自己的真实入口;公开部署、域名、后台、支付和账号功能需另行配置与授权,本技能不自动开通。 依赖:文字/代码模型(推荐GPT)、文件能力与浏览器预览。核心不需要图片API;本地四案例用真实Chrome分别验证1600×1200桌面、1200×1200方形视窗与390×844手机,无横向溢出,FAQ键盘展开、锚点、示例TXT下载内容通过。四张展示直接来自四个实际网页的方形首屏视窗,完整HTML与长页另留档;按笔记归档、会议状态、课程步骤与设计配色区分视觉,页面题材明确虚构,没有真实客户或销量。头像为独立原创HTML文字与图形封面,不是案例运行证据,不冒称生图API输出。 未追加YouMind运行测试、未验证持久模型绑定。静态官网不等于完整SaaS或真实服务上线,不保证转化、SEO排名、流量或任意平台直接预览;199积分不包含托管、域名、后台、模型运行或第三方服务费用。 展示说明:首张为独立技能头像与案例01实际输出的并排排版,用于横向缩略展示;不是新增案例,也未让生图模型重绘证据。其余三张对应案例02—04。
Information
- Version
- v2
- Last updated
- Runtime credits
- Usage-based
- Models
- Auto