feat(docs): theme change to docsy

jiacai2050 · Aug 17, 2024 · 0a4d869 · 0a4d869
1 parent 3850821
commit 0a4d869
Show file tree

Hide file tree

Showing 21 changed files with 162 additions and 124 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -45,6 +45,7 @@ jobs:
           HUGO_ENVIRONMENT: production
           HUGO_ENV: production
         run: |
+          npm i -D postcss postcss-cli autoprefixer
           hugo mod get
           hugo \
             --minify \

diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@
 /zig-cache
 /.zig-cache
 *lock
-docs/resources
+docs/resources
+docs/public
diff --git a/README.org b/README.org
diff --git a/README.org b/README.org
@@ -0,0 +1 @@
+docs/content/_index.org
diff --git a/docs/content.zh/_index.md b/docs/content.zh/_index.md
diff --git a/docs/content/_index.org b/docs/content/_index.org
diff --git a/docs/content/_index.org b/docs/content/_index.org
@@ -0,0 +1,24 @@
+#+TITLE: Zigcli
+#+DATE: 2023-10-21T12:09:48+0800
+#+LASTMOD: 2024-08-17T18:53:40+0800
+#+TYPE: docs
+#+author: Jiacai Liu
+
+[[https://github.com/jiacai2050/zigcli][https://img.shields.io/github/stars/jiacai2050/zigcli.svg]]
+[[https://github.com/jiacai2050/loc/actions/workflows/CI.yml][https://github.com/jiacai2050/loc/actions/workflows/CI.yml/badge.svg]]
+[[https://github.com/jiacai2050/loc/actions/workflows/binary.yml][https://github.com/jiacai2050/loc/actions/workflows/binary.yml/badge.svg]]
+[[https://img.shields.io/badge/zig%20version-0.13.0-blue.svg]]
+
+#+begin_quote
+[[https://zigcli.liujiacai.net/][Zigcli]] is a toolkit for building command lines programs in Zig.
+#+end_quote
+
+Official website: https://zigcli.liujiacai.net/
+
+It can be imported as [[https://zigcli.liujiacai.net/modules/][Zig modules]] or used directly as [[https://zigcli.liujiacai.net/programs/][binary programs]].
+
+* Who's Using
+If you're using =zigcli=, and would like to be added here, welcome to [[https://github.com/jiacai2050/zigcli/pulls][open a PR]].
+
+* License
+MIT, see [[https://github.com/jiacai2050/zigcli/blob/main/LICENSE][LICENSE]] for details.
diff --git a/docs/content/docs/modules/_index.md b/docs/content/docs/modules/_index.md
diff --git a/docs/content/docs/programs/_index.org b/docs/content/docs/programs/_index.org
diff --git a/docs/content/modules/_index.org b/docs/content/modules/_index.org
@@ -0,0 +1,29 @@
+#+TITLE: Modules
+#+DATE: 2024-08-17T17:58:01+0800
+#+LASTMOD: 2024-08-17T18:17:19+0800
+#+WEIGHT: 10
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
+#+DESCRIPTION: Zig modules
+
+
+* Install
+=zigcli= support [[https://ziglang.org/download/0.11.0/release-notes.html#Package-Management][package manager]] introduced in Zig 0.11.
+
+#+begin_src bash
+zig fetch --save=zigcli https://github.com/jiacai2050/zigcli/archive/${COMMIT}.tar.gz
+#+end_src
+
+#+RESULTS:
+
+Replace ~${COMMIT}~ with a real one, then in your =build.zig=, import the module like this:
+
+#+begin_src zig
+const zigcli = b.dependency("zigcli", .{});
+
+// Currently zigcli provide two modules.
+exe.root_module.addImport("simargs", zigcli.module("simargs"));
+exe.root_module.addImport("pretty-table", zigcli.module("pretty-table"));
+#+end_src
+
+* Available modules
diff --git a/docs/content/docs/modules/pretty-table.org → docs/content/modules/pretty-table.org b/docs/content/docs/modules/pretty-table.org → docs/content/modules/pretty-table.org
@@ -1,4 +1,10 @@
-* Pretty Table
+#+TITLE: Pretty Table
+#+DATE: 2024-08-17T17:48:29+0800
+#+LASTMOD: 2024-08-17T18:17:41+0800
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
+
+
 A formatted and aligned table printer library for Zig.
 * Features
 - Many box-drawing character to choose(=ascii=, =box=, =dos=).

diff --git a/docs/content/docs/modules/simargs.org → docs/content/modules/simargs.org b/docs/content/docs/modules/simargs.org → docs/content/modules/simargs.org
@@ -1,9 +1,9 @@
 #+TITLE: Simargs
 #+DATE: 2023-10-21T12:04:40+0800
-#+LASTMOD: 2024-08-11T20:30:59+0800
+#+LASTMOD: 2024-08-17T18:17:38+0800
+#+TYPE: docs
 #+WEIGTH: 1
 
-* Simargs
 A simple, opinionated, struct-based argument parser in Zig, taking full advantage of [[https://kristoff.it/blog/what-is-zig-comptime/][comptime]].
 * Features
 - Supported data type:

diff --git a/docs/content/programs/_index.org b/docs/content/programs/_index.org
@@ -0,0 +1,22 @@
+#+TITLE: Programs
+#+DATE: 2023-10-21T12:26:45+0800
+#+LASTMOD: 2024-08-17T18:17:57+0800
+#+TYPE: docs
+#+WEIGHT: 20
+#+DESCRIPTION: Binary programs which can be used directly
+
+* Install
+Prebuilt binaries can be found in [[https://github.com/jiacai2050/zigcli/actions/workflows/binary.yml][CI's artifacts]], or you can build from source:
+#+begin_src bash
+git clone https://github.com/jiacai2050/zigcli.git
+#+end_src
+Then build with
+#+begin_src bash
+make build
+#+end_src
+
+#+begin_quote
+To build zigcli locally, Zig master is required, which can be downloaded [[https://ziglang.org/download/][here]].
+#+end_quote
+
+* Available Programs
diff --git a/docs/content/docs/programs/dark-mode.org → docs/content/programs/dark-mode.org b/docs/content/docs/programs/dark-mode.org → docs/content/programs/dark-mode.org
@@ -1,4 +1,9 @@
-* Dark mode
+#+TITLE: Dark mode
+#+DATE: 2024-08-17T17:52:00+0800
+#+LASTMOD: 2024-08-17T18:18:44+0800
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
+
 Get dark mode status for macOS.
 #+begin_src bash
  $ dark-mode -h

diff --git a/docs/content/docs/programs/loc.org → docs/content/programs/loc.org b/docs/content/docs/programs/loc.org → docs/content/programs/loc.org
@@ -1,4 +1,9 @@
-* Loc
+#+TITLE: loc
+#+DATE: 2024-08-17T17:52:51+0800
+#+LASTMOD: 2024-08-17T18:18:48+0800
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
+
 #+begin_src bash :results verbatim code :exports both
 ./zig-out/bin/loc
 #+end_src

diff --git a/docs/content/docs/programs/night-shift.org → docs/content/programs/night-shift.org b/docs/content/docs/programs/night-shift.org → docs/content/programs/night-shift.org
@@ -1,4 +1,9 @@
-* Night shift
+#+TITLE: Night shift
+#+DATE: 2024-08-17T17:52:12+0800
+#+LASTMOD: 2024-08-17T18:18:58+0800
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
+
 A CLI for configuring "Night Shift" on macOS. 🌕🌖🌗🌘🌑
 
 #+begin_src bash :results verbatim code :exports both

diff --git a/docs/content/docs/programs/pidof.org → docs/content/programs/pidof.org b/docs/content/docs/programs/pidof.org → docs/content/programs/pidof.org
@@ -1,4 +1,9 @@
-* pidof
+#+TITLE: pidof
+#+DATE: 2024-08-17T17:52:44+0800
+#+LASTMOD: 2024-08-17T18:19:01+0800
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
+
 Linux has this command, but not macOS, so I write it for you.
 
 #+begin_src bash

diff --git a/docs/content/docs/programs/repeat.org → docs/content/programs/repeat.org b/docs/content/docs/programs/repeat.org → docs/content/programs/repeat.org
@@ -1,4 +1,9 @@
-* repeat
+#+TITLE: Repeat
+#+DATE: 2024-08-17T17:52:32+0800
+#+LASTMOD: 2024-08-17T18:19:06+0800
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
+
 #+begin_src bash
  $ ./zig-out/bin/repeat -h
  USAGE:

diff --git a/docs/content/docs/programs/tree.org → docs/content/programs/tree.org b/docs/content/docs/programs/tree.org → docs/content/programs/tree.org
@@ -1,5 +1,9 @@
+#+TITLE: Tree
+#+DATE: 2024-08-17T17:52:22+0800
+#+LASTMOD: 2024-08-17T18:19:15+0800
+#+TYPE: docs
+#+AUTHOR: Jiacai Liu
 
-* tree
 #+begin_src
 $ ./zig-out/bin/tree -h
  USAGE:

diff --git a/docs/content/roadmap.org b/docs/content/roadmap.org
@@ -0,0 +1,10 @@
+#+TITLE: Roadmap
+#+DATE: 2024-08-17T18:07:20+0800
+#+LASTMOD: 2024-08-17T18:19:47+0800
+#+WEIGHT: 30
+#+TYPE: docs
+
+* Loc
+- Performance, at least comparable with [[https://github.com/cgag/loc][cgag/loc]] [[https://github.com/jiacai2050/loc/issues/1][#1]]
+- More options, such as =--exclude <regex>=
+- Support multiline comment
diff --git a/docs/go.mod b/docs/go.mod
@@ -2,4 +2,6 @@ module github.com/jiacai2050/zigcli/docs
 
 go 1.21
 
-require github.com/alex-shpak/hugo-book v0.0.0-20230808113920-3f1bcccbfb24 // indirect
+require (
+	github.com/google/docsy v0.10.0 // indirect
+)
diff --git a/docs/go.sum b/docs/go.sum
@@ -1,2 +1,4 @@
-github.com/alex-shpak/hugo-book v0.0.0-20230808113920-3f1bcccbfb24 h1:8NjMYBSFTtBLeT1VmpZAZznPOt1OH8aNCnE86sL4p4k=
-github.com/alex-shpak/hugo-book v0.0.0-20230808113920-3f1bcccbfb24/go.mod h1:L4NMyzbn15fpLIpmmtDg9ZFFyTZzw87/lk7M2bMQ7ds=
+github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
+github.com/google/docsy v0.10.0 h1:6tMDacPwAyRWNCfvsn/9qGOZDQ8b0aRzjRZvnZPY5dg=
+github.com/google/docsy v0.10.0/go.mod h1:c0nIAqmRTOuJ01F85U/wJPQtc3Zj9N58Kea9bOT2AJc=
+github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
diff --git a/docs/hugo.toml b/docs/hugo.toml
@@ -3,30 +3,29 @@ languageCode = 'en-us'
 title = 'Zigcli'
 enableGitInfo = true
 
-[markup]
-[markup.goldmark.renderer]
-  unsafe = true
-
-[markup.tableOfContents]
-  startLevel = 1
-
-[languages]
-[languages.en]
-  languageName = 'English'
-  contentDir = 'content'
-  weight = 1
-
-# [languages.zh]
-#   languageName = 'Chinese'
-#   contentDir = 'content.zh'
-#   weight = 2
-
 [params]
-  BookTheme = 'auto'
-  BookRepo = 'https://github.com/jiacai2050/zigcli'
-  BookEditPath = 'edit/main/docs'
-  BookDateFormat = '2006-01-02T15:04:05 -0700'
+github_repo = 'https://github.com/jiacai2050/zigcli'
+github_subdir = 'docs'
+offlineSearch = true
 
 [module]
+proxy = "https://goproxy.cn,direct"
 [[module.imports]]
-path = 'github.com/alex-shpak/hugo-book'
+path = "github.com/google/docsy"
+
+[params.copyright]
+  authors = "Jiacai Liu | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) | "
+  from_year = 2023
+
+[params.ui]
+navbar_logo = false
+showLightDarkModeMenu = true
+
+[markup]
+  [markup.goldmark]
+    [markup.goldmark.parser.attribute]
+      block = true
+    [markup.goldmark.renderer]
+      unsafe = true
+  [markup.highlight]
+    style = 'tango'