mcaptcha.org website
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Aravinth Manivannan 72abb7e168
ci/woodpecker/push/woodpecker Pipeline was successful Details
Merge pull request 'feat: feb 2023 monthly report and limit deployment to master branch' (#18) from 02-23-monthly-report into master
2 weeks ago
.github run deploy routine only on this repo 1 year ago
archetypes index 2 years ago
assets feat: enable syntax highlighting 8 months ago
config fix: navbar and docs sections ordering with appropriate weights and add terminologies 8 months ago
content feat: publish feb 2023 monthly report and limit deployment to master branch 2 weeks ago
data index 2 years ago
images index 2 years ago
layouts fix: get started btn 8 months ago
scripts debug: ssh key 1 month ago
static feat: add NLnet funding details 3 weeks ago
.editorconfig index 2 years ago
.eslintignore index 2 years ago
.eslintrc.json index 2 years ago
.gitignore feat: migrate CI 1 month ago
.markdownlint.json index 2 years ago
.markdownlintignore index 2 years ago
.npmrc index 2 years ago
.stylelintignore index 2 years ago
.stylelintrc.json index 2 years ago
.versionrc.json index 2 years ago
.woodpecker.yml feat: publish feb 2023 monthly report and limit deployment to master branch 2 weeks ago
CHANGELOG.md index 2 years ago
CODE_OF_CONDUCT.md index 2 years ago
LICENSE.md index 2 years ago
Makefile debug: ssh key 1 month ago
README.md index 2 years ago
babel.config.js index 2 years ago
netlify.toml index 2 years ago
package-lock.json chore: update deps 1 month ago
package.json chore: upgrade deps 8 months ago
theme.toml index 2 years ago
yarn.lock chore: update deps 1 month ago

README.md

Doks

Doks

Modern documentation theme

Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.

GitHub GitHub release (latest SemVer including pre-releases) GitHub Workflow Status (branch) Netlify

Doks — Modern Documentation Theme

Demo

Quick start

Get your Doks site in 1 min.

Deploy to Netlify

Why Doks?

Nine 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.

  7. Full text search. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.

  8. Page layouts. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.

  9. Dark mode. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.

Requirements

Doks uses npm to install dependencies and run commands. Installing npm is pretty simple. Download and install Node.js (it includes npm) for your platform.

Get started

Start a new Doks project in three steps:

1. Create a new site

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

2. Install dependencies

npm install

3. Start development server

npm run start

Other commands

Doks comes with commands for common tasks.

Documentation

Communities

Blog