diff --git a/bin/build-vitepress-docs b/bin/build-vitepress-docs new file mode 100755 index 0000000..c2ed024 --- /dev/null +++ b/bin/build-vitepress-docs @@ -0,0 +1,9 @@ +#!/usr/bin/env bash +set -e + +build-vitepress-docs() { + cp README.md index.md + pnpm run docs:build + cp *.tgz .vitepress/dist || true + cp index.yaml .vitepress/dist || true +} diff --git a/bin/dev-vitepress-docs b/bin/dev-vitepress-docs new file mode 100755 index 0000000..3a3da6b --- /dev/null +++ b/bin/dev-vitepress-docs @@ -0,0 +1,7 @@ +#!/usr/bin/env bash +set -e + +dev-vitepress-docs() { + cp README.md index.md + pnpm run docs:dev +} diff --git a/bin/init-vitepress-docs b/bin/init-vitepress-docs new file mode 100755 index 0000000..3a5136d --- /dev/null +++ b/bin/init-vitepress-docs @@ -0,0 +1,25 @@ +#!/usr/bin/env bash +set -e + +init-vitepress-docs() { + if [[ ! -f "package.json" ]]; then + echo "Create package.json" + cat > package.json << 'EOF' +{ + "scripts": { + "docs:dev": "vitepress dev", + "docs:build": "vitepress build", + "docs:preview": "vitepress preview" + }, + "devDependencies": { + "vitepress": "^1.6.4" + } +} +EOF + fi + + echo "Install Vitepress dependencies" + pnpm install + + echo "Vitepress initialized" +} diff --git a/bin/serve-vitepress-docs b/bin/serve-vitepress-docs new file mode 100755 index 0000000..bb9de51 --- /dev/null +++ b/bin/serve-vitepress-docs @@ -0,0 +1,6 @@ +#!/usr/bin/env bash +set -e + +serve-vitepress-docs() { + pnpm run docs:preview +} diff --git a/docs/library.md b/docs/library.md index e56cd25..8d1963d 100644 --- a/docs/library.md +++ b/docs/library.md @@ -761,6 +761,38 @@ rows+=("serve-zensical-docs||Serve the Zensical documentation build folder.") +## Vitepress + +Build static sites with Vitepress. + + + +### init-vitepress-docs + +```bash +rows+=("init-vitepress-docs||Install Vitepress build dependencies.") +``` + +### dev-vitepress-docs + +```bash +rows+=("dev-vitepress-docs||Start Vitepress development server.") +``` + +### build-vitepress-docs + +```bash +rows+=("build-vitepress-docs||Create Vitepress build.") +``` + +### serve-vitepress-docs + +```bash +rows+=("serve-vitepress-docs||Serve Vitepress build.") +``` + + + ## Vuepress Build static sites with Vuepress. diff --git a/task.template b/task.template index ac7b210..42a9b0b 100644 --- a/task.template +++ b/task.template @@ -116,6 +116,11 @@ help-table() { rows+=("dev-zensical-docs||Run Zensical development server.") rows+=("build-zensical-docs||Build the Zensical documentation website.") rows+=("serve-zensical-docs||Serve the Zensical documentation build folder.") + rows+=("===Vitepress===| | ") + rows+=("init-vitepress-docs||Install Vitepress build dependencies.") + rows+=("dev-vitepress-docs||Start Vitepress development server.") + rows+=("build-vitepress-docs||Create Vitepress build.") + rows+=("serve-vitepress-docs||Serve Vitepress build.") rows+=("===Vuepress===| | ") rows+=("init-vuepress-docs||Install Vuepress build dependencies.") rows+=("dev-vuepress-docs||Start Vuepress development server.")