ctpassmore/mcaptcha-website
1
0
Fork 0
forked from mCaptcha/website
Code Issues Pull requests Projects Releases Packages Wiki Activity
mcaptcha.org website
54 commits 11 branches 0 tags 9.4 MiB
HTML 98.9%
SCSS 0.7%
JavaScript 0.2%
Shell 0.2%
Find a file
dat-adi 7b20d552e5 docs: Minor spelling error fixes 
- Removal of duplicate `flexibility`.
- Fixed the `mCapthca` typo to `mCaptcha`.
- `Decenber` to `December`.
2022-06-14 15:39:59 +05:30
.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 blog styling and pow performance post 2021-09-01 13:24:31 +05:30
config last edited partial 2021-05-27 19:15:04 +05:30
content docs: Minor spelling error fixes 2022-06-14 15:39:59 +05:30
data index 2021-03-09 18:56:02 +05:30
images index 2021-03-09 18:56:02 +05:30
layouts Fixed typo 2022-06-11 20:54:22 +05:30
static compresed logo images 2021-05-29 17:31:58 +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: 2022-05 monthly report 2022-06-14 14:04:44 +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
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
netlify.toml index 2021-03-09 18:56:02 +05:30
package-lock.json index 2021-03-09 18:56:02 +05:30
package.json index 2021-03-09 18:56:02 +05:30
README.md index 2021-03-09 18:56:02 +05:30
theme.toml index 2021-03-09 18:56:02 +05:30
yarn.lock update deps 2021-07-21 15:55:09 +05:30

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