wails/mkdocs-website/mkdocs.yml
2023-12-22 20:34:11 +11:00

197 lines
6.1 KiB
YAML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

site_name: "alpha"
repo_url: https://github.com/wailsapp/wails
edit_uri: edit/v3-alpha/mkdocs-website/docs/
site_url: https://v3alpha.wails.io
site_description: The Wails Project - Build beautiful cross-platform applications using Go
site_author: Lea Anthony
theme:
name: material
custom_dir: overrides
logo: assets/images/wails-logo-horizontal-dark.svg
icon:
repo: fontawesome/brands/github
favicon: /favicon.ico
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.instant.prefetch
- navigation.top
- navigation.footer
- navigation.path
- navigation.prune
- toc.integrate
- toc.follow
- search.suggest
- search.highlight
- search.share
- content.tabs.link
- content.tabs.annotation
- content.tabs.copy
- content.code.copy
- content.action.edit
language: en
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
plugins:
- table-reader:
data_path: "shared"
allow_missing_files: False
- i18n:
docs_structure: folder
languages:
- locale: en
default: true
name: English
build: true
# - locale: zh
# name: 简体中文
# build: true
# site_description: Wails 项目 - 使用 Go 构建美观的跨平台应用程序
# extra:
# announcement: 这些文档是自动生成的。 如有错误,请告知我们。
# nav:
# - 主页: index.md
# - 入门:
# # - 介绍: introduction.md
# - 安装: getting-started/installation.md
# # - 创建项目: getting-started/creating-a-project.md
# # - 它是如何工作的: how-does-it-work.md
# # - 开发您的应用程序: getting-started/developing-your-application.md
# # - 编译您的项目: getting-started/compiling-your-project.md
# # - API 参考:
# # - 运行时:
# # - 介绍: reference/runtime/introduction.md
# # - CLI: reference/cli.md
# # - 社区:
# # - 模板: community/templates.md
# # - 指南:
# # - Angular: guides/angular.md
# # - 展示:
# # - Emaillit: community/showcase/emailit.md
# # - 贡献: community/contributing.md
# # - 链接: community/links.md
# - 下一步: getting-started/next-steps.md
# - 反馈: getting-started/feedback.md
# - 反馈: getting-started/feedback.md
# - v3 版本中的新内容是什么?: whats-new.md
# - API:
# - 应用程序: API/application.md
# - 窗口: API/window.md
# - 系统托盘: API/systray.md
# - 菜单: API/menu.md
# - 主线程: API/mainthread.md
# - 完整 API: API/fullapi.md
# - 开发:
# - 介绍: development/introduction.md
# - 状态: development/status.md
# - v3 变更: development/changes.md
# - 路线图: roadmap.md
# - 更改日志: changelog.md
# - 赞助❤️: https://github.com/sponsors/leaanthony
extra:
# alternate:
# - name: English
# link: /
# lang: en
# - name: 简体中文
# link: /zh/
# lang: zh
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/wailsapp/wails
- icon: fontawesome/brands/twitter
link: https://twitter.com/wailsapp
- icon: fontawesome/brands/discord
link: https://discord.gg/JDdSxwjhGf
extra_css:
- stylesheets/extra.css
nav:
- Home: index.md
- Getting started:
# - Introduction: introduction.md
- Installation: getting-started/installation.md
# - Creating a Project: getting-started/creating-a-project.md
# - How does it work: how-does-it-work.md
# - Developing your Application: getting-started/developing-your-application.md
# - Compiling your Project: getting-started/compiling-your-project.md
# - API Reference:
# - Runtime:
# - Introduction: reference/runtime/introduction.md
# - CLI: reference/cli.md
# - Community:
# - Template: community/templates.md
# - Guides:
# - Angular: guides/angular.md
# - Showcase:
# - Emaillit: community/showcase/emailit.md
# - Contributing: community/contributing.md
# - Links: community/links.md
- Your First Application: getting-started/your-first-app.md
- Next Steps: getting-started/next-steps.md
- Feedback: getting-started/feedback.md
- Feedback: getting-started/feedback.md
- What's New in v3?: whats-new.md
- API:
- Application: API/application.md
- Window: API/window.md
- System Tray: API/systray.md
- Menu: API/menu.md
- Main Thread: API/mainthread.md
- Full API: API/fullapi.md
- Development:
- Introduction: development/introduction.md
- Status: development/status.md
- v3 Changes: development/changes.md
- Roadmap: roadmap.md
- Change Log: changelog.md
- Sponsor❤: https://github.com/sponsors/leaanthony
markdown_extensions:
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.inlinehilite
- pymdownx.snippets:
restrict_base_path: false
- pymdownx.details
- pymdownx.superfences
- pymdownx.mark
- attr_list
- admonition
- footnotes
- toc:
permalink: '#'
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
watch:
- overrides
- shared
copyright:
Copyright © 2023 Lea Anthony