-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy pathmkdocs.yml
129 lines (122 loc) · 4.17 KB
/
mkdocs.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
site_name: docs.instructlab.ai
site_url: https://docs.instructlab.ai
# Repository
repo_name: docs.instructlab.ai
repo_url: https://github.com/instructlab/docs.instructlab.ai
edit_uri: edit/main/docs
# Navigation
nav:
- Welcome:
- About InstructLab: index.md
- Getting Started:
- Install on Mac Metal: getting-started/mac_metal.md
- Install on Linux NVIDIA: getting-started/linux_nvidia.md
- Install on Linux AMD: getting-started/linux_amd.md
- Initialize InstructLab: getting-started/initilize_ilab.md
- Download models: getting-started/download_models.md
- Intro to serve and chat: getting-started/serve_and_chat.md
- Adding data to a model:
- Creating a new Wikipedia based qna.yaml: adding-data-to-model/creating_new_wikipedia_based_qna.md
- Creating New Knowledge or Skills: adding-data-to-model/creating_new_knowledge_or_skills.md
- Community:
- Code of Conduct: community/CODE_OF_CONDUCT.md
- Code of Conduct Committee: community/CODE_OF_CONDUCT_COMMITTEE.md
- FAQ: community/FAQ.md
- Governance Policy: community/GOVERNANCE.md
- Discord Guide: community/InstructLab_DISCORD_GUIDE.md
- Discord Moderation Guide: community/InstructLab_DISCORD_MODERATION_GUIDE.md
- Slack Guide: community/InstructLab_SLACK_GUIDE.md
- Slack Moderation Guide: community/InstructLab_SLACK_MODERATION_GUIDE.md
- Taxonomy:
- About Taxonomy: taxonomy/index.md
- Upstream Taxonomy Contributions:
- General Guidelines: taxonomy/upstream/contribution_guidelines.md
- Knowledge Guidelines: taxonomy/upstream/knowledge_contribution_details.md
- Skill Guidelines: taxonomy/upstream/skills_contribution_details.md
- Skills:
- Overview: taxonomy/skills/index.md
- File Structure: taxonomy/skills/file_structure.md
- Knowledge:
- Overview: taxonomy/knowledge/index.md
- File Structure: taxonomy/knowledge/file_structure.md
- User Interface:
- UI Overview: user-interface/ui_overview.md
- Chat with the model: user-interface/playground_chat.md
- Contribute knowledge to community model: user-interface/knowledge_contributions.md
- Contribute skills to community model: user-interface/skills_contributions.md
- UI Configurations: user-interface/env_oauth_config.md
- Community Model Build:
- About Community Model Build: cmb/index.md
- Community Model Build Process: cmb/build_process.md
- References:
- Additional Resources: resources/RESOURCES.md
- Contributors: resources/CONTRIBUTORS.md
- MkDocs Cheatsheet: resources/MKDOCS.md
## YOU SHOULD NOT CHANGE BELOW THIS LINE
# Copyright
copyright: Copyright © 2024- Red Hat Inc.
theme:
name: material
icon:
annotation: material/star-four-points-small
logo: material/library
logo: images/ilab_dog.png
palette:
scheme: default
primary:
primary: custom
accent: purple
features:
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
# Plugins
plugins:
- git-authors:
show_email_address: false
- git-committers:
repository: instructlab/docs.instructlab.ai
branch: main
- git-revision-date-localized:
enable_creation_date: true
- search
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- meta
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde