Skip to content

Latest commit

 

History

History
executable file
·
22 lines (14 loc) · 859 Bytes

README.md

File metadata and controls

executable file
·
22 lines (14 loc) · 859 Bytes

VivifyIdeas - Style guides

This repo is used for creating a static website for Vivify Ideas coding style guides for various tech stacks. The implementation itself has been achieved through the use of VuePress and the site is deployed to Github pages.

Dev set up

  • Clone the repository
  • Run yarn to install project dependencies
  • Run yarn build to create static site files inside of /docs/src/.vuepress/dist directory
  • Run yarn dev to start a local dev server on localhost:8080

Add new style guide pages

  • Create new md file in /docs/src directory
  • Add a sidebar link to it in /docs/.vuepress/config.js file, in themeConfig.sidebar section

Deploy

Thanks to Github Actions the site is deployed to Github pages automatically when something is pushed to master branch.