forked from minio/gluegun
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathsite-example.yml
executable file
·83 lines (65 loc) · 4.72 KB
/
site-example.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# Important: Edit and save file as site.yml file before generating docs.
Site: "Site Title" # Required - Title of Site
Output: "docs" # Required - Output directory where html files are generated
Logo: # Optional - Site Branding
Image: "https://<domain.com>/url-to-logo.svg" # Optional - Image for logo
Link: "https://<domain.com>/link-on-logo-click" # Optional - URL to navigate to when logo is clicked.
SEO Author: "Author Name" # Optional - Meta author tag for SEO
Language: # Optional - Translation links
- Chinese: https://<domain.com>/cn
- Japanese: https://<domain.com>/jp
Plugins: # Optional - Plugins (Algolia for search and Google Analytics)
- Algolia:
apiKey: "ALGOLIA_TOKEN"
index: "INDEX_NAME"
- Google Analytics: "UA-XXXXX-Y"
Documents: # Required - Documents with links to generate site
- Category Heading: # Required - Category Name
- Document Title: # Required - Document Title
Link: github link to the raw md file # Required - Document Link
Slug: document-title # Optional - Document Slug
SEO Title: "Document Title" # Optional - Page title tag
SEO Description: "Description" # Optional - Meta description tag for SEO
SEO Keywords: "keyword1, keyword2, keyword3" # Optional - Meta keywords tag for SEO
Options: hidden # Optional - The value 'hidden' allows user to render page but hide sidebar link
# Full Example Shown Below
# Site: "MinIO Docs" # Required - Title of Site
# Output: "docs" # Required - Output directory where html files are generated
# Logo: # Optional - Site Branding
# Image: "https://min.io/resources/img/logo/MINIO_wordmark_black.png" # Optional - Image for logo
# Link: "https://min.io" # Optional - URL to navigate to when logo is clicked.
# Language: # Optional - Translation links
# - Chinese: https://docs.min.io/cn
# - Japanese: https://docs.min.io/jp
# Plugins: # Optional - Plugins
# - Algolia:
# apiKey: "xxxxxxxxxxxxxxxx"
# index: "xxxxxxxx"
# - Google Analytics: "UA-xxxxxxx-Y"
# Documents: # Required - Documents with links to generate site
# - MinIO Server: # Required- Category Name
# - MinIO Server Quick Start Guide: # Required - Document Title
# Link: https://github.com/minio/minio/blob/master/README.md # Required - Document Link
# Slug: minio-server-quick-start-guide # Optional - Document Slug
# - MinIO Docker Quick Start Guide:
# Link: https://github.com/minio/minio/blob/master/docs/docker/README.md
# Slug: minio-docker-quick-start-guide
# - MinIO Gateway Guide:
# Link: https://github.com/minio/minio/blob/master/docs/gateway/README.md
# Slug: minio-gateway-guide
# - MinIO Client:
# - MinIO Client Quick Start Guide:
# Link: https://raw.githubusercontent.com/minio/mc/master/README.md
# - MinIO Client Complete Guide:
# Link: https://raw.githubusercontent.com/minio/mc/master/docs/minio-client-complete-guide.md
# Slug: minio-client-complete-guide
# - MinIO SDKs:
# - JavaScript Client Quickstart Guide:
# Link: https://raw.githubusercontent.com/minio/minio-js/master/README.md
# - JavaScript Client API Referece:
# Link: https://raw.githubusercontent.com/minio/minio-js/master/docs/API.md
# - MinIO Cookbook:
# - MinIO Limitations:
# Link: https://github.com/minio/minio/blob/master/docs/minio-limitations.md
# - MinIO FreeBSD Quickstart Guide:
# Link: https://github.com/minio/minio/blob/master/docs/FreeBSD.md