Update for applying Documentor

webpagine · Aug 18, 2024 · e4f827b · e4f827b
1 parent f48fc10
commit e4f827b
Show file tree

Hide file tree

Showing 29 changed files with 213 additions and 137 deletions.
diff --git a/.github/workflows/pagine.yml b/.github/workflows/pagine.yml
@@ -32,7 +32,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Pagine
-        run: go install github.com/webpagine/pagine/v2/cmd/pagine@v2.1.0
+        run: go install github.com/webpagine/pagine/v2/cmd/pagine@v2.3.0
 
       - name: Checkout
         uses: actions/checkout@v4

diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,9 @@
 [submodule "templates/genesis"]
 	path = templates/genesis
 	url = https://github.com/webpagine/genesis
+[submodule "templates/darkmode"]
+	path = templates/darkmode
+	url = https://github.com/webpagine/darkmode
+[submodule "templates/documentor"]
+	path = templates/documentor
+	url = https://github.com/webpagine/documentor
diff --git a/assets/img/pagine_icon_fit.svg b/assets/img/pagine_icon_fit.svg
diff --git a/en-US/docs/README.md → docs/en/v2.1/README.md b/en-US/docs/README.md → docs/en/v2.1/README.md
@@ -99,7 +99,7 @@ Example:  `page.html`
 <html lang="{{ .lang }}">
 <head>
   <title>{{ .title }}</title>
-  <link rel="stylesheet" href="{{ (getAttr).templateBase }}/css/base.css" />
+  <link rel="stylesheet" href="{{ engine.Attr.templateBase }}/css/base.css" />
 </head>
 <body>
 {{ template "header.html" .header }}

diff --git a/docs/en/v2.1/metadata.yaml b/docs/en/v2.1/metadata.yaml
@@ -0,0 +1,2 @@
+documentor:
+  lang: "en"
diff --git a/docs/en/v2.1/unit.yaml b/docs/en/v2.1/unit.yaml
@@ -0,0 +1,7 @@
+unit:
+  - template: "documentor"
+    template_key: "doc"
+    output: "/index.html"
+    define:
+      title: "Documentation"
+      content: "/README.md"
diff --git a/docs/metadata.yaml b/docs/metadata.yaml
@@ -0,0 +1,32 @@
+documentor:
+  root: "/docs"
+
+  lang: "en"
+  theme: "dark"
+
+  versions:
+    - "v2.1"
+
+  locales:
+    - locale: "en"
+      title: "English"
+
+    - locale: "zh"
+      title: "中文"
+
+  header:
+    title: '<span style="margin: 0 20px; font-size: 24px"><span style="font-weight: bolder">Pagine</span> Docs</span>'
+
+    logo:
+      src: "/assets/img/pagine_icon_fit.svg"
+      height: 50
+
+    nav:
+      - title: "Repositories"
+        link: "https://github.com/webpagine"
+
+  footer:
+    copyright:
+      owner: "Symboltics"
+      date: "2024"
+      license: "Text is available under the <a target=\"_blank\" href=\"https://creativecommons.org/licenses/by-sa/4.0/legalcode.en\">Creative Commons Attribution-ShareAlike License 4.0</a>; additional terms may apply."
diff --git a/docs/unit.yaml b/docs/unit.yaml
@@ -0,0 +1,4 @@
+unit:
+  - template: "documentor"
+    template_key: "locale"
+    output: "/index.html"
diff --git a/docs/zh/metadata.yaml b/docs/zh/metadata.yaml
@@ -0,0 +1,13 @@
+documentor:
+  lang: "zh"
+
+  header:
+    title: '<span style="margin: 0 20px; font-size: 24px"><span style="font-weight: bolder">Pagine</span> Docs</span>'
+
+    logo:
+      src: "/assets/img/pagine_icon_fit.svg"
+      height: 50
+
+    nav:
+      - title: "Repositories"
+        link: "https://github.com/webpagine"
diff --git a/docs/zh/unit.yaml b/docs/zh/unit.yaml
@@ -0,0 +1,6 @@
+unit:
+  - template: "documentor"
+    template_key: "redirect"
+    output: "index.html"
+    define:
+      target: "v2.1"
diff --git a/zh-CN/docs/README.md → docs/zh/v2.1/README.md b/zh-CN/docs/README.md → docs/zh/v2.1/README.md
@@ -97,7 +97,7 @@ export = "post.html" # Export `post.html`
 <html lang="{{ .lang }}">
 <head>
   <title>{{ .title }}</title>
-  <link rel="stylesheet" href="{{ (getAttr).templateBase }}/css/base.css" />
+  <link rel="stylesheet" href="{{ engine.Attr.templateBase }}/css/base.css" />
 </head>
 <body>
 {{ template "header.html" .header }}

diff --git a/docs/zh/v2.1/unit.yaml b/docs/zh/v2.1/unit.yaml
@@ -0,0 +1,7 @@
+unit:
+  - template: "documentor"
+    template_key: "doc"
+    output: "/index.html"
+    define:
+      title: "文档"
+      content: "/README.md"
diff --git a/en-US/docs/unit.toml b/en-US/docs/unit.toml
diff --git a/en-US/unit.toml b/en-US/unit.toml
diff --git a/en-US/unit.yaml b/en-US/unit.yaml
@@ -0,0 +1,7 @@
+unit:
+  - template: "genesis"
+    template_key: "page"
+    output: "/index.html"
+    define:
+      title: "Pagine - Web Generator"
+      content: "mainpage.html"
diff --git a/env.toml b/env.toml
diff --git a/env.yaml b/env.yaml
@@ -0,0 +1,10 @@
+ignore:
+  - ".git.*"
+  - ".*toml"
+  - ".*html"
+  - "templates/.*templates/"
+
+use:
+  genesis: "/templates/genesis"
+  darkmode: "/templates/darkmode"
+  documentor: "/templates/documentor"
diff --git a/metadata.toml b/metadata.toml
diff --git a/metadata.yaml b/metadata.yaml
@@ -0,0 +1,86 @@
+genesis:
+  lang: "en"
+  locale: "en-US"
+  theme: "dark"
+
+  locales:
+    - locale: "en-US"
+      title: "English"
+
+    - locale: "zh-CN"
+      title: "简体中文"
+
+  head:
+    icon: "https://avatars.githubusercontent.com/u/168826426"
+
+  header:
+    logo:
+      src: "/assets/img/pagine.svg"
+      height: 50
+
+    nav:
+      - title: "Documentation"
+        link: "/docs/"
+
+      - title: "Repositories"
+        link: "https://github.com/webpagine"
+
+  footer:
+    logo:
+      src: "/assets/img/symboltics_mono.svg"
+      height: 40
+
+    copyright:
+      owner: "Symboltics"
+      date: "2024"
+      license: "Text is available under the <a target=\"_blank\" href=\"https://creativecommons.org/licenses/by-sa/4.0/legalcode.en\">Creative Commons Attribution-ShareAlike License 4.0</a>; additional terms may apply."
+
+    lists:
+      - title: "About Symboltics"
+        links:
+          - name: "Vision"
+            link: "https://symboltics.com"
+
+          - name: "Mission"
+            link: "https://symboltics.com"
+
+          - name: "Where we go"
+            link: "https://symboltics.com"
+
+          - name: "Where we come"
+            link: "https://symboltics.com"
+
+      - title: "Infrastructure"
+        links:
+          - name: "LangVM"
+            link: "https://github.com/langvm"
+
+          - name: "Symonarch"
+            link: "https://github.com/symonarch"
+
+          - name: "HyperArchy"
+            link: "https://github.com/hyperarchy"
+
+          - name: "Web Pagine"
+            link: "https://github.com/webpagine"
+
+      - title: "Services"
+        links:
+          - name: "Modularis"
+            link: "https://github.com/symboltics/modularis"
+
+    media:
+      - icon: "github"
+        link: "https://github.com/jellyterra"
+
+      - icon: "x"
+        link: "https://x.com/jellyterra"
+
+      - icon: "discord"
+        link: "https://discord.gg/SBbp7M4nus"
+
+      - icon: "element"
+        link: "https://matrix.to/#/#webpagine:matrix.org"
+
+      - icon: "telegram"
+        link: "https://t.me/webpagine"
diff --git a/templates/darkmode b/templates/darkmode
diff --git a/templates/documentor b/templates/documentor
diff --git a/templates/genesis b/templates/genesis
diff --git a/unit.toml b/unit.toml
diff --git a/unit.yaml b/unit.yaml
@@ -0,0 +1,12 @@
+unit:
+  - template: "genesis"
+    template_key: "page"
+    output: "/404.html"
+    define:
+      title : "Pagine - Web Generator"
+      content: "404.html"
+  - template: "genesis"
+    template_key: "locale"
+    output: "/index.html"
+    define:
+      title: "Pagine - Web Generator"
diff --git a/zh-CN/docs/unit.toml b/zh-CN/docs/unit.toml
diff --git a/zh-CN/metadata.toml b/zh-CN/metadata.toml
diff --git a/zh-CN/metadata.yaml b/zh-CN/metadata.yaml
@@ -0,0 +1,3 @@
+genesis:
+  lang: "zh"
+  locale: "zh-CN"
diff --git a/zh-CN/unit.toml b/zh-CN/unit.toml