From 793cc64738b0077c4195d269671e4c2dfa030fde Mon Sep 17 00:00:00 2001 From: yeasy Date: Tue, 24 Mar 2026 21:25:04 -0700 Subject: [PATCH] Migrate docs to mdpress --- .github/workflows/ci.yaml | 18 +++++++++--------- .gitignore | 1 + docker-compose.yml | 16 ++++++++-------- package.json | 9 +++++---- 4 files changed, 23 insertions(+), 21 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 95248cf..9576822 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -20,14 +20,14 @@ jobs: node-version: 20 - name: Install docs dependencies run: npm install - - name: Build Gitbook - run: npm run honkit:build - - name: Build Gitbook Docker Image + - name: Build mdPress site + run: npm run build + - name: Build mdPress Docker Image if: github.repository == 'docker-practice/docker_practice' run: | - sudo chmod -R 777 _book + sudo chmod -R 777 _site echo "FROM nginx:alpine" >> Dockerfile - echo "COPY _book /usr/share/nginx/html" >> Dockerfile + echo "COPY _site /usr/share/nginx/html" >> Dockerfile echo "COPY .docker/docker-entrypoint.sh /" >> Dockerfile echo "ENTRYPOINT [\"/docker-entrypoint.sh\"]" >> Dockerfile @@ -35,7 +35,7 @@ jobs: docker build \ -t dockerpracticesig/docker_practice \ - -t dockerpracticesig/docker_practice:gitbook \ + -t dockerpracticesig/docker_practice:mdpress \ --label org.opencontainers.image.revision=$VCS_REF \ --label org.opencontainers.image.source="https://github.com/yeasy/docker_practice" \ --label maintainer="https://github.com/docker-practice" \ @@ -51,11 +51,11 @@ jobs: echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin docker push dockerpracticesig/docker_practice - docker push dockerpracticesig/docker_practice:gitbook + docker push dockerpracticesig/docker_practice:mdpress env: DOCKER_PASSWORD: ${{secrets.DOCKER_PASSWORD}} DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}} - - name: Upload Gitbook dist + - name: Upload mdPress dist uses: docker://pcit/pages if: github.repository == 'docker-practice/docker_practice' env: @@ -63,7 +63,7 @@ jobs: PCIT_GIT_TOKEN: ${{ secrets.PCIT_GIT_TOKEN }} PCIT_GIT_URL: github.com/docker-practice/zh-cn PCIT_KEEP_HISTORY: "true" - PCIT_LOCAL_DIR: _book + PCIT_LOCAL_DIR: _site PCIT_MESSAGE: Build from yeasy/docker_practice@${{github.sha}} PCIT_TARGET_BRANCH: master PCIT_USERNAME: khs1994 diff --git a/.gitignore b/.gitignore index b206c01..9071864 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ *.tmp .idea/ _book/ +_site* format_report.txt *.swp *.edx diff --git a/docker-compose.yml b/docker-compose.yml index d54a157..f26fcfe 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,29 +2,29 @@ version: "3" services: - gitbook-build: - &gitbook-build + mdpress-build: + &mdpress-build image: yeasy/docker_practice:latest volumes: - ./:/srv/gitbook-src command: build - gitbook-server: - << : *gitbook-build + mdpress-server: + << : *mdpress-build ports: - 4000:4000 command: server # docker run -it --rm -p 4000:80 dockerpracticesig/docker_practice - gitbook-offline: - &gitbook-offline + mdpress-offline: + &mdpress-offline # this image build by GitHub Action - image: dockerpracticesig/docker_practice:gitbook + image: dockerpracticesig/docker_practice:mdpress ports: - 4000:80 vuepress-offline: - << : *gitbook-offline + << : *mdpress-offline image: dockerpracticesig/docker_practice:vuepress # developer test docker image diff --git a/package.json b/package.json index 1dd4562..e0d3d48 100644 --- a/package.json +++ b/package.json @@ -11,16 +11,17 @@ "gitbook-plugin-github": "^3.0.0", "gitbook-plugin-mermaid-gb3": "^2.1.0", "gitbook-plugin-page-treeview": "^3.0.6", - "honkit": "^6.1.6", "vuepress": "1.9.10", "vuepress-plugin-container": "^2.1.5", "vuepress-theme-hope": "^1.0.0" }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "honkit:help": "npx honkit help", - "honkit:build": "npx honkit build", - "honkit:serve": "npx honkit serve", + "mdpress:help": "mdpress --help", + "build": "rm -rf _site _site_site && mdpress build --format site --output _site && rm -rf _site && mv _site_site _site", + "serve": "mdpress serve", + "start": "mdpress serve", + "pdf": "mdpress build --format pdf", "vuepress:build": "npx vuepress build", "vuepress": "npx vuepress" },