CARVIEW |
Select Language
HTTP/2 200
date: Thu, 24 Jul 2025 15:29:19 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
etag: W/"6045ab39e2eea32d49d1f00730036836"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=rs8e%2FY6inEh3MrsD3vS8gEmyO2CYb1qyblvtQxiqZxmarnPvt6i3ktcw5ywHLXDDbmzHt2x3R%2B%2BzP%2FgR%2B8GJaUJybpgnFaWdBHGlep8o36hGD8jz6ScEomPkiE8%2F9yOH3ZSgtU25dbmvCyTuFfMABxAg%2BTUm9Cna5zBoAJl8Y5Y7ZM1CAsaGBGX0Vlwr11bKW9YpW2Q%2Fpm6TZ0CmbUO%2FyasmRE51QOcXCfwgupssd3KzQ3bjGGB1uMVBzGUrSjOzCD2kTmBsM15ZtczmG9iLkQ%3D%3D--IXDYVK%2F7ghUxNUgq--un%2BwHa4DUF3aBXvwvgUV2w%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1061129095.1753370959; Path=/; Domain=github.com; Expires=Fri, 24 Jul 2026 15:29:19 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Fri, 24 Jul 2026 15:29:19 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: E39C:4AA7B:98BA2:B1EEA:6882514F
Configuration for Documentation and Demo · ant-design/ant-design Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 53.1k
Configuration for Documentation and Demo
Benjy Cui edited this page Oct 21, 2016
·
3 revisions
We use YAML to set the configuration of documentation.
---
order: 1
title: Introduction
---
Configurations of documentation and demo are different.
If a Markdown file is under a folder named demo
, it is a demo. Here is an example.
-
title: string | Object
The title of demo. If it is an object, it has the following fields:zh-CN: string
en-US: string
-
debug: boolean
This demo is just for debugging, and it will be threw away while building. -
order: number
The order of demo.Normal demo should start from
0
ton
, demo for debugging should start from-1
to-n
. -
only: boolean
Only show this demo. It's useful to debug locally.
If a Markdown file is not a demo, it is a documentation. e.g.: https://github.com/ant-design/ant-design/blob/e1a6123aa6a4cf47b3be8d681692b7256d4485c6/components/checkbox/index.md
-
category: string
文档分类,可自行定义。 -
order: number
在当前分类下的展示顺序。 -
type: string
组件类型,特别针对组件文档,目前有基本
表单
展示
导航
其他
。 -
title: string | Object
文档标题,与演示标题一致支持多语言设置。 -
subtitle: string | Object
文档副标题,与演示标题一致支持多语言设置。 -
cols:1 | 2
页面代码演示区块的展示列数,默认为2
,对于演示宽度不够的组件可设置为1
。 -
disabled: boolean
使侧边菜单的链接不可点。
- Home
- Cookbook
- FAQ
- Template for Bug Report in IE8 9
- Contributing
- Maintaining
- Design
Clone this wiki locally
You can’t perform that action at this time.