https://github.com/daggerok/vuepress-docs-howto
Quick and fast rapid VuePress documentation development
https://github.com/daggerok/vuepress-docs-howto
travis travis-ci travis-config-gh-publish travis-deploy travisci vuepress vuepress-ci vuepress-doc
Last synced: over 1 year ago
JSON representation
Quick and fast rapid VuePress documentation development
- Host: GitHub
- URL: https://github.com/daggerok/vuepress-docs-howto
- Owner: daggerok
- License: mit
- Created: 2019-09-10T00:25:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-01T23:21:34.000Z (about 5 years ago)
- Last Synced: 2025-01-10T00:37:20.573Z (over 1 year ago)
- Topics: travis, travis-ci, travis-config-gh-publish, travis-deploy, travisci, vuepress, vuepress-ci, vuepress-doc
- Language: JavaScript
- Homepage: https://daggerok.github.io/vuepress-docs-howto/
- Size: 3.25 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
home: true
heroText: VuePress
tagline: Quickstart
footer: Made by Maksim Kostromin with ❤️ 🤘
---
# vuepress-docs-howto [](https://github.com/daggerok/vuepress-docs-howto/actions/workflows/ci.yaml)
Quick and fast rapid VuePress documentation development
[[toc]]
## Quickstart new project
Start from documentation:
```bash
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
```sh
# npm i -E
npm run build
npx serve .vuepress/dist/
```
open [http://localhost:8080/](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](@/.github/workflows/ci.yaml)
That README.md documentation file is compiled and deployed on [GitHub Pages](https://daggerok.github.io/vuepress-docs-howto/)