mirror of https://github.com/wg-easy/wg-easy
Browse Source
* move docs to zensical * fix requirements * fixes * remove manual font loading does not work properly with mike * switch back to pymdownx.blocks.admonition * revert back * remove css * add note about privacy plugin * pr review findingspull/2668/head
Bernd Storath
18 hours ago
committed by
GitHub
GitHub
21 changed files with 157 additions and 121 deletions
@ -1,3 +1,6 @@ |
|||||
.DS_Store |
.DS_Store |
||||
*.swp |
*.swp |
||||
node_modules |
node_modules |
||||
|
|
||||
|
docs/site |
||||
|
docs/.cache |
||||
@ -1,87 +0,0 @@ |
|||||
site_name: 'wg-easy' |
|
||||
site_description: 'The easiest way to run WireGuard VPN + Web-based Admin UI.' |
|
||||
site_author: 'WireGuard Easy' |
|
||||
copyright: > |
|
||||
<p> |
|
||||
© <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> |
|
||||
<span>This project is licensed under AGPL-3.0-only.</span><br/> |
|
||||
<span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> |
|
||||
<span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> |
|
||||
</p> |
|
||||
|
|
||||
repo_url: https://github.com/wg-easy/wg-easy |
|
||||
repo_name: wg-easy |
|
||||
|
|
||||
edit_uri: 'edit/master/docs/content' |
|
||||
|
|
||||
docs_dir: 'content/' |
|
||||
|
|
||||
site_url: https://wg-easy.github.io/wg-easy |
|
||||
|
|
||||
theme: |
|
||||
name: material |
|
||||
favicon: assets/logo/favicon.png |
|
||||
logo: assets/logo/logo.png |
|
||||
icon: |
|
||||
repo: fontawesome/brands/github |
|
||||
features: |
|
||||
- navigation.tabs |
|
||||
- navigation.top |
|
||||
- navigation.expand |
|
||||
- navigation.instant |
|
||||
- content.action.edit |
|
||||
- content.action.view |
|
||||
- content.code.annotate |
|
||||
palette: |
|
||||
# Light mode |
|
||||
- media: '(prefers-color-scheme: light)' |
|
||||
scheme: default |
|
||||
primary: grey |
|
||||
accent: red |
|
||||
toggle: |
|
||||
icon: material/weather-night |
|
||||
name: Switch to dark mode |
|
||||
# Dark mode |
|
||||
- media: '(prefers-color-scheme: dark)' |
|
||||
scheme: slate |
|
||||
primary: grey |
|
||||
accent: red |
|
||||
toggle: |
|
||||
icon: material/weather-sunny |
|
||||
name: Switch to light mode |
|
||||
|
|
||||
extra: |
|
||||
version: |
|
||||
provider: mike |
|
||||
|
|
||||
markdown_extensions: |
|
||||
- toc: |
|
||||
anchorlink: true |
|
||||
- abbr |
|
||||
- attr_list |
|
||||
- pymdownx.blocks.admonition: |
|
||||
types: |
|
||||
- danger |
|
||||
- note |
|
||||
- info |
|
||||
- question |
|
||||
- warning |
|
||||
- pymdownx.details |
|
||||
- pymdownx.superfences: |
|
||||
custom_fences: |
|
||||
- name: mermaid |
|
||||
class: mermaid |
|
||||
format: !!python/name:pymdownx.superfences.fence_code_format |
|
||||
- pymdownx.tabbed: |
|
||||
alternate_style: true |
|
||||
slugify: !!python/object/apply:pymdownx.slugs.slugify |
|
||||
kwds: |
|
||||
case: lower |
|
||||
- pymdownx.tasklist: |
|
||||
custom_checkbox: true |
|
||||
- pymdownx.magiclink |
|
||||
- pymdownx.inlinehilite |
|
||||
- pymdownx.tilde |
|
||||
- pymdownx.emoji: |
|
||||
emoji_index: !!python/name:material.extensions.emoji.twemoji |
|
||||
emoji_generator: !!python/name:material.extensions.emoji.to_svg |
|
||||
@ -1,4 +1,2 @@ |
|||||
mkdocs-material |
zensical==0.0.45 |
||||
pillow |
git+https://github.com/squidfunk/mike.git |
||||
cairosvg |
|
||||
mike |
|
||||
|
|||||
@ -0,0 +1,97 @@ |
|||||
|
[project] |
||||
|
site_name = "wg-easy" |
||||
|
site_description = "The easiest way to run WireGuard VPN + Web-based Admin UI." |
||||
|
site_author = "WireGuard Easy" |
||||
|
copyright = """ |
||||
|
<p> |
||||
|
© <a href="https://github.com/wg-easy"><em>Wireguard Easy</em></a><br/> |
||||
|
<span>This project is licensed under AGPL-3.0-only.</span><br/> |
||||
|
<span>This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security</span><br/> |
||||
|
<span>"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld</span> |
||||
|
</p> |
||||
|
""" |
||||
|
|
||||
|
repo_url = "https://github.com/wg-easy/wg-easy" |
||||
|
repo_name = "wg-easy" |
||||
|
|
||||
|
edit_uri = "edit/master/docs/content" |
||||
|
|
||||
|
docs_dir = "content/" |
||||
|
|
||||
|
site_url = "https://wg-easy.github.io/wg-easy" |
||||
|
|
||||
|
[project.theme] |
||||
|
variant = "modern" |
||||
|
favicon = "assets/logo/favicon.png" |
||||
|
logo = "assets/logo/logo.png" |
||||
|
features = [ |
||||
|
"navigation.instant", |
||||
|
"navigation.tabs", |
||||
|
"navigation.expand", |
||||
|
"navigation.path", |
||||
|
"navigation.top", |
||||
|
"content.action.edit", |
||||
|
"content.action.view", |
||||
|
"content.code.copy", |
||||
|
"content.code.annotate", |
||||
|
] |
||||
|
|
||||
|
[project.theme.icon] |
||||
|
repo = "fontawesome/brands/github" |
||||
|
|
||||
|
# Palette toggle for automatic mode |
||||
|
[[project.theme.palette]] |
||||
|
media = "(prefers-color-scheme)" |
||||
|
toggle.icon = "lucide/sun-moon" |
||||
|
toggle.name = "Switch to light mode" |
||||
|
|
||||
|
# Palette toggle for light mode |
||||
|
[[project.theme.palette]] |
||||
|
media = "(prefers-color-scheme: light)" |
||||
|
scheme = "default" |
||||
|
primary = "grey" |
||||
|
accent = "red" |
||||
|
toggle.icon = "lucide/sun" |
||||
|
toggle.name = "Switch to dark mode" |
||||
|
|
||||
|
# Palette toggle for dark mode |
||||
|
[[project.theme.palette]] |
||||
|
media = "(prefers-color-scheme: dark)" |
||||
|
scheme = "slate" |
||||
|
primary = "grey" |
||||
|
accent = "red" |
||||
|
toggle.icon = "lucide/moon" |
||||
|
toggle.name = "Switch to system preference" |
||||
|
|
||||
|
# [project.plugins.privacy] |
||||
|
|
||||
|
[project.extra.version] |
||||
|
provider = "mike" |
||||
|
|
||||
|
[project.markdown_extensions.pymdownx.blocks.admonition] |
||||
|
types = ["danger", "note", "info", "question", "warning"] |
||||
|
|
||||
|
[project.markdown_extensions.md_in_html] |
||||
|
|
||||
|
[project.markdown_extensions.toc] |
||||
|
permalink = true |
||||
|
|
||||
|
[project.markdown_extensions.pymdownx.details] |
||||
|
|
||||
|
[project.markdown_extensions.pymdownx.emoji] |
||||
|
emoji_generator = "zensical.extensions.emoji.to_svg" |
||||
|
emoji_index = "zensical.extensions.emoji.twemoji" |
||||
|
|
||||
|
[project.markdown_extensions.pymdownx.highlight] |
||||
|
anchor_linenums = true |
||||
|
line_spans = "__span" |
||||
|
pygments_lang_class = true |
||||
|
|
||||
|
[project.markdown_extensions.pymdownx.inlinehilite] |
||||
|
|
||||
|
[project.markdown_extensions.pymdownx.smartsymbols] |
||||
|
|
||||
|
[project.markdown_extensions.pymdownx.superfences] |
||||
|
custom_fences = [ |
||||
|
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }, |
||||
|
] |
||||
Loading…
Reference in new issue