A self hosted toolset for building interactive websites on top of Vuepress.
- Markdown driven website
- Interactive Vue components as first class citizen
- Auto-generated sidebar based on nested folder structure
- New components can be developed anywhere in the site root; and embedded into Markdown
- Hosted via GitHub pages
- Deployed automatically via GitHub Actions
If setup correctly (see below); you should be able to access this site on:
- Hot-reloading provided by Vuepress
- Mocha test framework included
- Linting included as part of tests
- Testing on PRs via Github Actions
- Make sure you have the latest version Node LTS installed
- Copy this template in GitHub
- Check out the code locally
- Run:
npm install - Run:
node first-time-setup.js - Go to Github > Settings > Pages and enable publishing from the
gh-pagesbranch
See: LICENSE.md
The hosted vuesite packages together:
- @fortawesome/fontawesome-svg-core
- @fortawesome/free-solid-svg-icons
- @fortawesome/vue-fontawesome
- @vuepress/plugin-register-components
- @vuepress/theme-default
- axios
- time-until
- vuepress
Whilst the build tools require:
- @connected-web/md2json
- capture-website-cli
- chai
- eslint
- eslint-plugin-html
- eslint-plugin-mocha
- eslint-plugin-vue
- mocha
- node-localstorage
- promise-path
- standard
Which come with their own terms and conditions.