自定义 README

1
readme:
2
  bannerLink: "https://example.com/banner"
3
  introduction: "Welcome to our API"
4
  apiReferenceLink: "https://docs.example.com"
5
  apiName: "Example Product"
6
  exampleStyle: "minimal"
7
  disabledSections:
8
    - "contributing"
9
  defaultEndpoint:
10
    method: "POST"
11
    path: "/users"
12
    stream: false
13
  customSections:
14
    - title: "Custom Section"
15
      language: "java"
16
      content: |
17
        This is a custom section. Latest package info is {{ group }}:{{ artifact }}:{{ version }}.
18
    - title: "Custom Section"
19
      language: "typescript"
20
      content: |
21
        Custom section for {{ packageName }}
22
    - title: "Another Custom Section"
23
      language: "typescript"
24
      content: |
25
        A second custom section for {{ packageName }}
26
  features:
27
    authentication:
28
      - method: "POST"
29
        path: "/auth/login"
30
      - "GET /auth/profile"
31
    users:
32
      - method: "GET"
33
        path: "/users"
34
      - method: "POST"
35
        path: "/users"