mirror of
https://github.com/Yamato-Security/WELA.git
synced 2026-06-30 22:18:20 +02:00
Shirofune-Security
a95f0f5eec
Add a documentation website under website/, built from README.md and README-Japanese.md and laid out with top-tab topics and a left sidebar (same style as the Hayabusa docs). Designed to be hosted free on GitHub Pages. - Pages: Overview (About, Features, Screenshots), Getting Started, Commands (Command List, Command Usage), Resources (Companion Projects, Other Resources, Changelog, Contributing) - Custom landing page, theme, click-to-zoom screenshots - Changelog synced from CHANGELOG.md at build time - 15-language switcher via mkdocs-static-i18n: English + Japanese full content; the other 13 localize the UI and fall back to English until translated - .github/workflows/docs.yml builds (mkdocs --strict) + deploys to GitHub Pages Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
199 lines
5.4 KiB
YAML
199 lines
5.4 KiB
YAML
# =============================================================================
|
|
# WELA Documentation Site — Material for MkDocs
|
|
# -----------------------------------------------------------------------------
|
|
# Hosted for free on GitHub Pages (see ../.github/workflows/docs.yml).
|
|
# Top tabs = main topics, left sidebar = subtopics.
|
|
# >>> If you fork/rename, update site_url, repo_url and repo_name below. <<<
|
|
# =============================================================================
|
|
|
|
site_name: WELA
|
|
site_description: >-
|
|
WELA (Windows Event Log Analyzer, ゑ羅) is a tool for auditing Windows event log settings.
|
|
site_author: Yamato Security
|
|
site_url: https://yamato-security.github.io/WELA/
|
|
|
|
repo_url: https://github.com/Yamato-Security/WELA
|
|
repo_name: Yamato-Security/WELA
|
|
edit_uri: edit/main/website/docs/
|
|
|
|
copyright: >-
|
|
Copyright © Yamato Security — Documentation built with Material for MkDocs
|
|
|
|
docs_dir: docs
|
|
|
|
theme:
|
|
name: material
|
|
language: en
|
|
logo: assets/screenshots/WELA-Logo.png
|
|
favicon: assets/screenshots/WELA-Logo.png
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
font:
|
|
text: Inter
|
|
code: JetBrains Mono
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.top
|
|
- navigation.footer
|
|
- navigation.tracking
|
|
- toc.follow
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.tooltips
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 3
|
|
slugify: !!python/object/apply:pymdownx.slugs.slugify
|
|
kwds:
|
|
case: lower
|
|
- pymdownx.details
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.keys
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
|
|
plugins:
|
|
- search
|
|
- glightbox:
|
|
touchNavigation: true
|
|
loop: false
|
|
effect: zoom
|
|
width: 100%
|
|
auto_caption: false
|
|
- i18n:
|
|
docs_structure: suffix
|
|
fallback_to_default: true
|
|
reconfigure_material: true
|
|
reconfigure_search: true
|
|
languages:
|
|
- locale: en
|
|
default: true
|
|
name: English
|
|
build: true
|
|
- locale: ja
|
|
name: 日本語
|
|
build: true
|
|
site_name: WELA ドキュメント
|
|
nav_translations:
|
|
Home: ホーム
|
|
Overview: 概要
|
|
About WELA: WELAについて
|
|
Features: 機能
|
|
Screenshots: スクリーンショット
|
|
Getting Started: はじめに
|
|
Commands: コマンド
|
|
Command List: コマンド一覧
|
|
Command Usage: コマンド使用例
|
|
Resources: リソース
|
|
Companion Projects: 関連プロジェクト
|
|
Other Resources: その他の参考資料
|
|
Changelog: 変更履歴
|
|
Contributing & Support: 貢献とサポート
|
|
- locale: zh-TW
|
|
name: 繁體中文
|
|
build: true
|
|
- locale: ko
|
|
name: 한국어
|
|
build: true
|
|
- locale: de
|
|
name: Deutsch
|
|
build: true
|
|
- locale: tr
|
|
name: Türkçe
|
|
build: true
|
|
- locale: fr
|
|
name: Français
|
|
build: true
|
|
- locale: es
|
|
name: Español
|
|
build: true
|
|
- locale: pt-BR
|
|
name: Português (Brasil)
|
|
build: true
|
|
- locale: uk
|
|
name: Українська
|
|
build: true
|
|
- locale: hi
|
|
name: हिन्दी
|
|
build: true
|
|
- locale: id
|
|
name: Bahasa Indonesia
|
|
build: true
|
|
- locale: my
|
|
name: မြန်မာဘာသာ
|
|
build: true
|
|
- locale: th
|
|
name: ไทย
|
|
build: true
|
|
- locale: ar
|
|
name: العربية
|
|
build: true
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/Yamato-Security/WELA
|
|
name: WELA on GitHub
|
|
- icon: fontawesome/brands/x-twitter
|
|
link: https://twitter.com/SecurityYamato
|
|
name: Yamato Security on X
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Overview:
|
|
- About WELA: overview/index.md
|
|
- Features: overview/features.md
|
|
- Screenshots: overview/screenshots.md
|
|
- Getting Started: getting-started/index.md
|
|
- Commands:
|
|
- Command List: commands/index.md
|
|
- Command Usage: commands/usage.md
|
|
- Resources:
|
|
- Companion Projects: resources/companion-projects.md
|
|
- Other Resources: resources/other-resources.md
|
|
- Changelog: resources/changelog.md
|
|
- Contributing & Support: resources/contributing.md
|