vuepress-docs-howto (opens new window)

Quick and fast rapid VuePress documentation development

• Quickstart new project
• Build and serve
• Publish via CI

Quickstart new project

Start from documentation:

wget -qO- https://github.com/daggerok/vuepress-docs-howto/archive/master.zip | tar xvf -
mkdir /tmp/1 && wget -qO- https://github.com/daggerok/vuepress-docs-howto/archive/master.zip | tar xvf - -C $_
# tar -xvf <(curl -sL https://github.com/daggerok/vuepress-docs-howto/archive/master.zip)
# jar -xvf <(curl -sL https://github.com/daggerok/vuepress-docs-howto/archive/master.zip)
mv /tmp/1/vuepress-docs-howto-master /tmp/my-new-project
cd /tmp/my-new-project
# find and replace: vuepress-docs-howto -> my-new-project
# such as: BASE='/my-new-project/'
vi package.json
vi .vuepress/config.js

Build and serve

# npm i -E
npm run build
npx serve .vuepress/dist/

open http://localhost:8080/ (opens new window) url

Publish via CI

Checkout .github/workflows/ci.yaml file to see how easily you can deploy your VuePress docs on GitHub Pages:

name: 'GitHub actions'
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]
jobs:
  github-pages:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/cache@v2
        id: cache-npm
        with:
          path: ~/.npm
          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
      - uses: actions/setup-node@v2
      - run: npm i -E ; npm run gh-pages
      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.0
        with:
          branch: gh-pages # The branch the action should deploy to.
          folder: .vuepress/dist # The folder the action should deploy.

That README.md documentation file is compiled and deployed on GitHub Pages (opens new window)