personal-security-checklist/docs/pages/docs-site-docs.md

Documentation for the GitHub Docs Site

Installing

Simply clone the repo, navigate into the new directory, install dependencies, build, and your ready to go!

git clone https://github.com/Lissy93/voronoi-site-template.git
cd voronoi-site-template
yarn

Building, Developing and Deploying

• npm run build Triggers complete webpack build
• npm run start Opens the standalone version
• npm run serve Runs app on a lightweight node server
• npm run dev Starts webpack-dev-server, for live changes
• npm run clean Removes all generated files and libraries
• npm run test Executes the test scripts

Note: You should only need to modify files within the /src directory, and the *.md files. Anything else will be overidden when webpack builds.

Credits

• This project uses Docsify to display MD docs and for navigation
• The homepage Vonoroi visualisation was based on Mike Bostock's origional D3.js voronoi script.

License

Licensed under MIT, (C) Alicia Sykes 2018. Read full License.