ResiLien
/
portails
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
portails/README.md

2.7 KiB
Raw Blame History

Doks

GitHub release Build Status Netlify

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:

  1. Security aware. Get A+ scores on Mozilla Observatory out of the box. Easily change the default Security Headers to suit your needs.

  2. Fast by default. Get 100 scores on Google Lighthouse by default. Doks removes unused css, prefetches links, and lazy loads images.

  3. SEO-ready. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.

  4. Development tools. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.

  5. Bootstrap framework. Build robust, flexible, and intuitive websites with Bootstrap. Or use any other front-end framework if you prefer.

  6. 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:

  • Hugo >= 0.75.0/extended
  • Node.js >= 14.15.0 (needed to install npm packages and run scripts

Get started

Create a new Doks project:

git clone https://github.com/h-enk/doks.git my-doks-site

Install dependencies:

# @ my-doks-site/
$ npm run install

Build development theme with live reloading and injection:

# @ my-doks-site/
$ npm run start

Other commands

  • npm run lint:styles - Check Sass for errors
  • npm run lint:scripts - Check JavaScript for errors
  • npm run clean - Delete temporary directories
  • npm run build - Build production theme

Quick start

Get your Doks site in 1 min.

Deploy to Netlify

Example site

👉 doks.netlify.app

Documentation

Communities