feat(docs): switch docs to zensical (#125)

2026-01-13 21:09:27 +04:00
parent f9757679c2
commit e671da0a0f
11 changed files with 259 additions and 466 deletions
@@ -0,0 +1,158 @@
+[project]
+site_name = "takopi"
+site_description = "takopi - telegram bridge for coding agents"
+site_author = "banteg"
+site_url = "https://takopi.banteg.xyz/"
+repo_url = "https://github.com/banteg/takopi"
+repo_name = "banteg/takopi"
+edit_uri = "edit/master/docs/"
+docs_dir = "docs"
+site_dir = "_site"
+
+nav = [
+  { "Home" = "index.md" },
+  { "Tutorials" = [
+    { "Overview" = "tutorials/index.md" },
+    { "Install & onboard" = "tutorials/install-and-onboard.md" },
+    { "First run" = "tutorials/first-run.md" },
+  ] },
+  { "How-to" = [
+    { "Overview" = "how-to/index.md" },
+    { "Switch engines" = "how-to/switch-engines.md" },
+    { "Projects" = "how-to/projects.md" },
+    { "Worktrees" = "how-to/worktrees.md" },
+    { "Route by chat" = "how-to/route-by-chat.md" },
+    { "Topics" = "how-to/topics.md" },
+    { "Voice notes" = "how-to/voice-notes.md" },
+    { "File transfer" = "how-to/file-transfer.md" },
+    { "Schedule tasks" = "how-to/schedule-tasks.md" },
+    { "Troubleshooting" = "how-to/troubleshooting.md" },
+    { "Write a plugin" = "how-to/write-a-plugin.md" },
+    { "Add a runner" = "how-to/add-a-runner.md" },
+    { "Dev setup" = "how-to/dev-setup.md" },
+  ] },
+  { "Reference" = [
+    { "Overview" = "reference/index.md" },
+    { "Commands & directives" = "reference/commands-and-directives.md" },
+    { "Configuration" = "reference/config.md" },
+    { "Environment variables" = "reference/env-vars.md" },
+    { "Changelog" = "reference/changelog.md" },
+    { "Specification" = "reference/specification.md" },
+    { "Plugin API" = "reference/plugin-api.md" },
+    { "Context resolution" = "reference/context-resolution.md" },
+    { "Telegram transport" = "reference/transports/telegram.md" },
+    { "Runners" = [
+      { "Overview" = "reference/runners/index.md" },
+      { "Claude" = [
+        { "Runner" = "reference/runners/claude/runner.md" },
+        { "Stream JSON cheatsheet" = "reference/runners/claude/stream-json-cheatsheet.md" },
+        { "Takopi events" = "reference/runners/claude/takopi-events.md" },
+      ] },
+      { "Codex" = [
+        { "Exec JSON cheatsheet" = "reference/runners/codex/exec-json-cheatsheet.md" },
+        { "Takopi events" = "reference/runners/codex/takopi-events.md" },
+      ] },
+      { "OpenCode" = [
+        { "Runner" = "reference/runners/opencode/runner.md" },
+        { "Stream JSON cheatsheet" = "reference/runners/opencode/stream-json-cheatsheet.md" },
+        { "Takopi events" = "reference/runners/opencode/takopi-events.md" },
+      ] },
+      { "Pi" = [
+        { "Runner" = "reference/runners/pi/runner.md" },
+        { "Stream JSON cheatsheet" = "reference/runners/pi/stream-json-cheatsheet.md" },
+        { "Takopi events" = "reference/runners/pi/takopi-events.md" },
+      ] },
+    ] },
+    { "For agents" = [
+      { "Agent entrypoint" = "reference/agents/index.md" },
+      { "Repo map" = "reference/agents/repo-map.md" },
+      { "Invariants" = "reference/agents/invariants.md" },
+    ] },
+  ] },
+  { "Explanation" = [
+    { "Overview" = "explanation/index.md" },
+    { "Architecture" = "explanation/architecture.md" },
+    { "Routing & sessions" = "explanation/routing-and-sessions.md" },
+    { "Plugin system" = "explanation/plugin-system.md" },
+    { "Module map" = "explanation/module-map.md" },
+  ] },
+]
+
+[project.extra]
+generator = false
+
+[[project.extra.social]]
+icon = "fontawesome/brands/x-twitter"
+link = "https://x.com/banteg"
+
+[[project.extra.social]]
+icon = "fontawesome/brands/telegram"
+link = "https://t.me/+4VRTEKT_To0wMTUy"
+
+[project.theme]
+language = "en"
+logo = "assets/logo.svg"
+favicon = "assets/favicon.svg"
+font.text = "Nunito"
+font.code = "Fira Code"
+features = [
+  "navigation.sections",
+  "navigation.instant",
+  "navigation.tracking",
+  "navigation.tabs",
+  "navigation.tabs.sticky",
+  "navigation.expand",
+  "navigation.footer",
+  "toc.follow",
+  "content.code.copy",
+  "content.action.edit",
+  "content.action.view",
+  "search.highlight",
+]
+
+[project.theme.icon]
+repo = "fontawesome/brands/github"
+
+[[project.theme.palette]]
+media = "(prefers-color-scheme)"
+toggle.icon = "lucide/sun-moon"
+toggle.name = "Switch to light mode"
+
+[[project.theme.palette]]
+media = "(prefers-color-scheme: light)"
+scheme = "default"
+primary = "pink"
+accent = "teal"
+toggle.icon = "lucide/sun"
+toggle.name = "Switch to dark mode"
+
+[[project.theme.palette]]
+media = "(prefers-color-scheme: dark)"
+scheme = "slate"
+primary = "pink"
+accent = "teal"
+toggle.icon = "lucide/moon"
+toggle.name = "Switch to system preference"
+
+[project.markdown_extensions.admonition]
+[project.markdown_extensions.attr_list]
+[project.markdown_extensions.md_in_html]
+[project.markdown_extensions.tables]
+
+[project.markdown_extensions.pymdownx.emoji]
+emoji_index = "zensical.extensions.emoji.twemoji"
+emoji_generator = "zensical.extensions.emoji.to_svg"
+
+[project.markdown_extensions.toc]
+permalink = true
+
+[project.markdown_extensions.pymdownx.superfences]
+custom_fences = [
+  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
+]
+
+[project.plugins.mkdocstrings.handlers.python]
+paths = ["src"]
+
+[project.plugins.mkdocstrings.handlers.python.options]
+show_source = false