mcaptcha.org website

Find a file

Renovate Bot 3c85cf7cbe chore(deps): update dependency hugo-bin to ^0.133.0		2024-10-15 16:07:24 +00:00
.github	run deploy routine only on this repo	2021-10-29 20:09:16 +05:30
archetypes	index	2021-03-09 18:56:02 +05:30
assets	feat: enable syntax highlighting	2022-08-01 22:23:24 +05:30
config	feat: mcaptcha/cli isntructions	2023-10-28 01:09:37 +05:30
content	Update content/docs/self-hosting/getting-started.md	2024-09-12 18:26:39 +05:30
data	index	2021-03-09 18:56:02 +05:30
images	index	2021-03-09 18:56:02 +05:30
layouts	fix: getting started link	2023-10-30 15:51:33 +05:30
scripts	feat: stash changes before checkout	2023-10-21 14:52:48 +05:30
static	feat: add NLnet funding details	2023-03-08 17:28:52 +05:30
.editorconfig	index	2021-03-09 18:56:02 +05:30
.eslintignore	index	2021-03-09 18:56:02 +05:30
.eslintrc.json	index	2021-03-09 18:56:02 +05:30
.gitignore	feat: migrate CI	2023-02-13 16:19:26 +05:30
.markdownlint.json	index	2021-03-09 18:56:02 +05:30
.markdownlintignore	index	2021-03-09 18:56:02 +05:30
.npmrc	index	2021-03-09 18:56:02 +05:30
.stylelintignore	index	2021-03-09 18:56:02 +05:30
.stylelintrc.json	index	2021-03-09 18:56:02 +05:30
.versionrc.json	index	2021-03-09 18:56:02 +05:30
.woodpecker.yml	hotfix: use custom docker img to use nodev16	2023-10-21 14:49:07 +05:30
babel.config.js	index	2021-03-09 18:56:02 +05:30
CHANGELOG.md	index	2021-03-09 18:56:02 +05:30
CODE_OF_CONDUCT.md	index	2021-03-09 18:56:02 +05:30
LICENSE.md	index	2021-03-09 18:56:02 +05:30
Makefile	debug: ssh key	2023-02-13 16:51:59 +05:30
netlify.toml	index	2021-03-09 18:56:02 +05:30
package-lock.json	chore(deps): update dependency hugo-bin to ^0.133.0	2024-10-15 16:07:24 +00:00
package.json	chore(deps): update dependency hugo-bin to ^0.133.0	2024-10-15 16:07:24 +00:00
README.md	index	2021-03-09 18:56:02 +05:30
renovate.json	Add renovate.json	2024-06-04 07:36:57 +00:00
theme.toml	index	2021-03-09 18:56:02 +05:30
yarn.lock	chore(deps): update dependency hugo-bin to ^0.133.0	2024-10-15 16:07:24 +00:00

README.md

Doks

Modern documentation theme

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

Demo

doks.netlify.app

Quick start

Get your Doks site in 1 min.

Why Doks?

Nine 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.
Full text search. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.
Page layouts. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.
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