From b8476429405928c299a906ca376862949585549b Mon Sep 17 00:00:00 2001 From: Yuya Asano <64895419+sukeya@users.noreply.github.com> Date: Thu, 28 May 2026 22:31:59 +0900 Subject: [PATCH] Move zensical from mkdocs. --- .github/workflows/deploy.yml | 54 +++++++++++---- .github/workflows/requirements.txt | 7 -- mkdocs.yml | 88 ------------------------- zensical.toml | 101 +++++++++++++++++++++++++++++ 4 files changed, 141 insertions(+), 109 deletions(-) delete mode 100644 .github/workflows/requirements.txt delete mode 100644 mkdocs.yml create mode 100644 zensical.toml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 0591d5d..09fd0b8 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,29 +1,55 @@ -name: Deploy +name: Documentation on: push: branches: - main + pull_request: jobs: - deploy: + build: runs-on: ubuntu-latest permissions: - contents: write + contents: read steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 + - uses: actions/setup-python@v6 with: - fetch-depth: 0 - - name: Set up Python - uses: actions/setup-python@v5 + python-version: "3.13" + - name: Install Zensical + run: | + python -m pip install --upgrade pip + pip install zensical + - name: Build docs + run: zensical build --clean + + deploy: + if: ${{ github.event_name == 'push' && github.ref_name == 'main' }} + needs: build + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + permissions: + contents: read + pages: write + id-token: write + steps: + - uses: actions/configure-pages@v5 + - uses: actions/checkout@v5 + - uses: actions/setup-python@v6 with: - python-version: '3.12' - architecture: 'x64' - - name: Set up MkDocs + python-version: "3.13" + - name: Install Zensical run: | python -m pip install --upgrade pip - pip install -r .github/workflows/requirements.txt + pip install zensical + - name: Build docs + run: zensical build --clean + - uses: actions/upload-pages-artifact@v4 + with: + path: site - name: Deploy - env: - MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }} - run: mkdocs gh-deploy + id: deployment + uses: actions/deploy-pages@v4 + diff --git a/.github/workflows/requirements.txt b/.github/workflows/requirements.txt deleted file mode 100644 index 0681cb9..0000000 --- a/.github/workflows/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -mkdocs -mkdocs-glightbox -mkdocs-material -markdown -pymdown-extensions -mkdocs-git-revision-date-localized-plugin -mkdocs-git-committers-plugin-2 diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index d76963e..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,88 +0,0 @@ -site_name: 私の愛した数式 -site_url: https://sukeya.github.io/ -repo_url: https://github.com/sukeya/sukeya.github.io -repo_name: sukeya/sukeya.github.io -edit_uri: blob/main/docs/ -nav: - - '概要': index.md - - OSS: - - platanus: /platanus/ - - '記事': - - 'Thrustの非同期実行': ./articles/thrust-async.md - - 'Apple Magic Keyboardの設定': ./articles/config-apple-magic-keyboard-in-ubuntu.md - - 'Alembicの使い方': ./articles/how-to-use-alembic.md - - 'perf_event_paranoidを変更できない時の対処法': ./articles/cannot-change-perf-event-paranoid.md - - 'gdbでのスタックトレースの自動取得': ./articles/gdb-get-stacktrace.md - - 'Eigenで行優先の行列を行優先のベクトルに変換する時、ベクトルのイテレータを`std::contiguous_iterator`にする方法': ./articles/make-reshaped-matrix-iterator-contiguous.md - - 'oneTBBの使い方': ./articles/how_to_use_onetbb.md - - 'Ubuntu 25.04上のRadeonでRusticlを使う方法': ./articles/how_to_use_rusticl_with_radeon_on_ubuntu.md - - 'AMD RDNA4のハードウェアの概要': ./articles/overview_of_RDNA4_hardware.md - - 'Address sanitizerとEigenを一緒に使うとき': ./articles/eigen_with_asan.md - - 'Expression templatesのダングリング対策について': ./articles/expression_templates.md - - 'CUDAプログラミングガイド 日本語解説': /cuda_programming_guide_jp/ -not_in_nav: | - thrust.md - memo.md -theme: - name: material - favicon: img/blog_logo.png - icon: - repo: fontawesome/brands/github - features: - - content.code.copy - - content.action.edit - - toc.integrate - - navigation.top - - navigation.indexes - palette: - # Palette toggle for automatic mode - - media: "(prefers-color-scheme)" - toggle: - icon: material/brightness-auto - name: Switch to light mode - # Palette toggle for light mode - - media: "(prefers-color-scheme: light)" - scheme: default - toggle: - icon: material/brightness-7 - name: Switch to dark mode - # Palette toggle for dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - toggle: - icon: material/brightness-4 - name: Switch to system preference -markdown_extensions: - - admonition - - attr_list - - footnotes - - md_in_html - - pymdownx.blocks.caption - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.details - - pymdownx.inlinehilite - - pymdownx.snippets - - pymdownx.superfences - - toc: - permalink: true - slugify: !!python/object/apply:pymdownx.slugs.slugify - kwds: - case: lower - - pymdownx.arithmatex: - generic: true -plugins: - - git-revision-date-localized: - enable_creation_date: true - type: iso_date - - git-committers: - repository: sukeya/sukeya.github.io - branch: main - token: !!python/object/apply:os.getenv ["MKDOCS_GIT_COMMITTERS_APIKEY"] - - glightbox - - search -extra_javascript: - - javascripts/mathjax.js - - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js diff --git a/zensical.toml b/zensical.toml new file mode 100644 index 0000000..dfb806f --- /dev/null +++ b/zensical.toml @@ -0,0 +1,101 @@ +[project] +site_name = "私の愛した数式" +site_url = "https://sukeya.github.io/" +repo_url = "https://github.com/sukeya/sukeya.github.io" +edit_uri = "blob/main/docs/" +docs_dir = "docs" +extra_javascript = [ + "javascripts/mathjax.js", + "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js" +] +nav = [ + { "概要" = "index.md" }, + { "OSS" = [ + { "platanus" = "/platanus/" } + ] }, + { "記事" = [ + { "Thrustの非同期実行" = "./articles/thrust-async.md" }, + { "Apple Magic Keyboardの設定" = "./articles/config-apple-magic-keyboard-in-ubuntu.md" }, + { "Alembicの使い方" = "./articles/how-to-use-alembic.md" }, + { "perf_event_paranoidを変更できない時の対処法" = "./articles/cannot-change-perf-event-paranoid.md" }, + { "gdbでのスタックトレースの自動取得" = "./articles/gdb-get-stacktrace.md" }, + { "Eigenで行優先の行列を行優先のベクトルに変換する時、ベクトルのイテレータを`std::contiguous_iterator`にする方法" = "./articles/make-reshaped-matrix-iterator-contiguous.md" }, + { "oneTBBの使い方" = "./articles/how_to_use_onetbb.md" }, + { "Ubuntu 25.04上のRadeonでRusticlを使う方法" = "./articles/how_to_use_rusticl_with_radeon_on_ubuntu.md" }, + { "AMD RDNA4のハードウェアの概要" = "./articles/overview_of_RDNA4_hardware.md" }, + { "AMD HIP" = "./articles/hip/intro/intro.md" }, + { "Address sanitizerとEigenを一緒に使うとき" = "./articles/eigen_with_asan.md" }, + { "Expression templatesのダングリング対策について" = "./articles/expression_templates.md" } + ] }, + { "CUDAプログラミングガイド 日本語解説" = "/cuda_programming_guide_jp/" } +] + +[project.theme] +favicon = "img/blog_logo.png" +features = [ + "content.code.copy", + "content.action.edit", + "toc.integrate", + "navigation.top", + "navigation.indexes" +] + +[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" +toggle.icon = "lucide/sun" +toggle.name = "Switch to dark mode" + +[[project.theme.palette]] +media = "(prefers-color-scheme: dark)" +scheme = "slate" +toggle.icon = "lucide/moon" +toggle.name = "Switch to system preference" + +[project.markdown_extensions.admonition] + +[project.markdown_extensions.attr_list] + +[project.markdown_extensions.footnotes] + +[project.markdown_extensions.md_in_html] + +[project.markdown_extensions.pymdownx.blocks.caption] + +[project.markdown_extensions.pymdownx.highlight] +anchor_linenums = true +line_spans = "__span" +pygments_lang_class = true + +[project.markdown_extensions.pymdownx.details] + +[project.markdown_extensions.pymdownx.inlinehilite] + +[project.markdown_extensions.pymdownx.snippets] + +[project.markdown_extensions.pymdownx.superfences] + +[project.markdown_extensions.tables] + +[project.markdown_extensions.toc] +permalink = true +slugify = {callable = "pymdownx.slugs.slugify", kwds = {case = "lower"}} + +[project.markdown_extensions.pymdownx.arithmatex] +generic = true + +[project.plugins.git-revision-date-localized] +enable_creation_date = true +type = "iso_date" + +[project.plugins.glightbox] + +[project.plugins.search]