Skip to content

Commit 9eaa77e

Browse files
committed
fix: docs
1 parent 547ed4f commit 9eaa77e

File tree

1 file changed

+202
-10
lines changed

1 file changed

+202
-10
lines changed

docs/_config.yml

Lines changed: 202 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,205 @@
1-
exclude:
2-
- macosagent
3-
- tests
4-
- examples
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole site, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing these this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'jekyll serve'. If you change this file, please restart the server process.
510

6-
remote_theme: marella/jekyll-theme-documentation
11+
# Site settings
12+
# These are used to personalize your new site. If you look in the HTML files,
13+
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
14+
# You can create any custom variable you would like, and they will be accessible
15+
# in the templates via {{ site.myvariable }}.
16+
title: MacOS Agent Documentation
17+
description: Documentation for the MacOS Agent project
18+
baseurl: "" # the subpath of your site, e.g. /blog
19+
url: "https://computer-use-agents.github.io/" # the base hostname & protocol for your site, e.g. http://example.com
20+
repository: computer-use-agents/MacOS-Agent # for github-metadata
721

822
permalink: pretty
9-
nav:
10-
- Getting Started:
11-
- Introduction: ''
12-
- Examples:
13-
- Markdown: docs/examples
23+
24+
defaults:
25+
- scope:
26+
path: "docs" # an empty string here means all files in the project
27+
type: "pages"
28+
values:
29+
layout: "default"
30+
31+
exclude:
32+
# from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
33+
- .sass-cache/
34+
- .jekyll-cache/
35+
- gemfiles/
36+
- Gemfile
37+
- Gemfile.lock
38+
- node_modules/
39+
- vendor/bundle/
40+
- vendor/cache/
41+
- vendor/gems/
42+
- vendor/ruby/
43+
# specific to the theme website:
44+
- bin/
45+
- lib/
46+
- "*.gemspec"
47+
- "*.gem"
48+
- LICENSE.txt
49+
- package.json
50+
- package-lock.json
51+
- Rakefile
52+
- README.md
53+
- CODE_OF_CONDUCT.md
54+
- docker-compose.yml
55+
- Dockerfile
56+
# theme test code
57+
- fixtures/
58+
59+
# Set a path/url to a logo that will be displayed instead of the title
60+
#logo: "/assets/images/just-the-docs.png"
61+
62+
# Enable or disable the site search
63+
# Supports true (default) or false
64+
search_enabled: true
65+
search:
66+
# Split pages into sections that can be searched individually
67+
# Supports 1 - 6, default: 2
68+
heading_level: 2
69+
# Maximum amount of previews per search result
70+
# Default: 3
71+
previews: 2
72+
# Maximum amount of words to display before a matched word in the preview
73+
# Default: 5
74+
preview_words_before: 3
75+
# Maximum amount of words to display after a matched word in the preview
76+
# Default: 10
77+
preview_words_after: 3
78+
# Set the search token separator
79+
# Default: /[\s\-/]+/
80+
# Example: enable support for hyphenated search words
81+
tokenizer_separator: /[\s/]+/
82+
# Display the relative url in search results
83+
# Supports true (default) or false
84+
rel_url: true
85+
# Enable or disable the search button that appears in the bottom right corner of every page
86+
# Supports true or false (default)
87+
button: false
88+
# Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
89+
focus_shortcut_key: "k"
90+
91+
# For copy button on code
92+
enable_copy_code_button: true
93+
94+
# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
95+
mermaid:
96+
# Version of mermaid library
97+
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
98+
version: "9.1.6"
99+
# Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
100+
# See also docs/ui-components/code
101+
# To load mermaid from a local library, also use the `path` key to specify the location of the library; e.g.
102+
# for (v10+):
103+
# path: "/assets/js/mermaid.esm.min.mjs"
104+
# for (<v10):
105+
# path: "/assets/js/mermaid.min.js"
106+
# Note: copy both `mermaid.esm.min.mjs` (v10+) or `mermaid.min.js` (<v10) and the associated `.map` file from the specified version of `mermaid/dist` to `/assets/js/`.
107+
108+
# Enable or disable heading anchors
109+
heading_anchors: true
110+
111+
# Aux links for the upper right navigation
112+
aux_links:
113+
"MacOS Agent on GitHub":
114+
- "https://github.com/computer-use-agents/MacOS-Agent"
115+
116+
# Makes Aux links open in a new tab. Default is false
117+
aux_links_new_tab: false
118+
119+
# Enable or disable the side/mobile menu globally
120+
# Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
121+
nav_enabled: true
122+
123+
# Sort order for navigation links
124+
# nav_sort: case_insensitive # default, equivalent to nil
125+
nav_sort: case_sensitive # Capital letters sorted before lowercase
126+
127+
# External navigation links
128+
nav_external_links:
129+
- title: MacOS Agent on GitHub
130+
url: https://github.com/computer-use-agents/MacOS-Agent
131+
132+
# Show navigation error report
133+
nav_error_report: true # default is false/nil.
134+
135+
liquid:
136+
error_mode: strict
137+
strict_filters: true
138+
139+
# Footer content
140+
# appears at the bottom of every page's main content
141+
142+
# Back to top link
143+
back_to_top: true
144+
back_to_top_text: "Back to top"
145+
146+
footer_content: 'Copyright &copy; 2025 Computer Use Agents. Distributed by an <a href="https://github.com/computer-use-agents/MacOS-Agent/tree/main/LICENSE.txt">MIT license.</a> <a href="https://www.netlify.com/">This site is powered by Netlify.</a>'
147+
148+
# Footer last edited timestamp
149+
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
150+
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
151+
152+
# Footer "Edit this page on GitHub" link text
153+
gh_edit_link: true # show or hide edit this page link
154+
gh_edit_link_text: "Edit this page on GitHub"
155+
gh_edit_repository: "https://github.com/computer-use-agents/MacOS-Agent" # the github URL for your repo
156+
gh_edit_branch: "main" # the branch that your docs is served from
157+
# gh_edit_source: docs # the source that your files originate from
158+
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
159+
160+
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
161+
color_scheme: nil
162+
163+
callouts_level: quiet # or loud
164+
callouts:
165+
highlight:
166+
color: yellow
167+
important:
168+
title: Important
169+
color: blue
170+
new:
171+
title: New
172+
color: green
173+
note:
174+
title: Note
175+
color: purple
176+
warning:
177+
title: Warning
178+
color: red
179+
180+
# Google Analytics Tracking (optional)
181+
# Supports a CSV of tracking ID strings (eg. "UA-1234567-89,G-1AB234CDE5")
182+
# Note: the main Just the Docs site does *not* use Google Analytics.
183+
# ga_tracking: UA-2709176-10,G-5FG1HLH3XQ
184+
# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
185+
186+
plugins:
187+
- jekyll-seo-tag
188+
- jekyll-github-metadata
189+
- jekyll-include-cache
190+
- jekyll-sitemap
191+
192+
kramdown:
193+
syntax_highlighter_opts:
194+
block:
195+
line_numbers: false
196+
197+
compress_html:
198+
clippings: all
199+
comments: all
200+
endings: all
201+
startings: []
202+
blanklines: false
203+
profile: false
204+
# ignore:
205+
# envs: all

0 commit comments

Comments
 (0)