Skip to content

daggerok/vuepress-docs-howto

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

home heroText tagline footer
true
VuePress
Quickstart
Made by Maksim Kostromin with ❤️ 🤘

vuepress-docs-howto GitHub actions

Quick and fast rapid VuePress documentation development [[toc]]

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/ url

Publish via CI

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

@code transcludeWith=::include lang=yaml

That README.md documentation file is compiled and deployed on GitHub Pages