Website documentation for Hashids.
Get Node.js, Grunt. Be sure you have Sass and Handlebars.js installed.
This is a static website that auto-generates pages for different implementations. There's two main files to update:
src/data.json
src/template.html
data.json
contains majority of the implementation data that populates the site. template.html
is the template.
Run the following in your git repo:
npm run production
This will keep watching your files for changes and updating whatever's needed. When done, git push
your changes.
Hashids website either uses or is built with the following. Muchas gracias to their respective creators for making these:
Node - Node.js is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications.
npm - Node.js package manager
Grunt - The JavaScript Task Runner
Handlebars.js - Minimal Templating on Steroids
Sass - Syntactically Awesome Style Sheets
Mouapp - The missing Markdown editor for web developers
highlight.js - Syntax highlighting for the Web
Font Awesome - The iconic font and CSS toolkit
Octodex - Github octocats
FlexSlider - An awesome, fully responsive jQuery slider toolkit
Google Fonts used: