2.8 KiB
Doks
Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.
Why Doks?
Six reasons why you should use Doks:
-
Security aware. Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.
-
Fast by default. Get 100 scores on Google Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.
-
SEO-ready. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
-
Development tools. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.
-
Bootstrap framework. Build robust, flexible, and intuitive websites with Bootstrap. Or use any other front-end framework if you prefer.
-
Netlify-ready. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.
Requirements
Make sure all dependencies have been installed:
Get started
Create a new Doks project:
git clone https://github.com/h-enk/doks.git my-doks-site
Install npm packages:
# @ my-doks-site/
$ npm install
Start local development server:
# @ my-doks-site/
$ npm run start
Other commands
npm run lint:styles- Check Sass for errorsnpm run lint:scripts- Check JavaScript for errorsnpm run clean- Delete temporary directoriesnpm run build- Build production website
Quick start
Get your Doks site in 1 min.
