Nuestro sitio
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.
 
 
 
El Mau 98414289bb Nuevo sitio 11 months ago
..
.github Nuevo sitio 11 months ago
archetypes Nuevo sitio 11 months ago
assets Nuevo sitio 11 months ago
config Nuevo sitio 11 months ago
content/es Nuevo sitio 11 months ago
data Nuevo sitio 11 months ago
functions Nuevo sitio 11 months ago
i18n Nuevo sitio 11 months ago
images Nuevo sitio 11 months ago
layouts Nuevo sitio 11 months ago
static Nuevo sitio 11 months ago
.editorconfig Nuevo sitio 11 months ago
.eslintignore Nuevo sitio 11 months ago
.eslintrc.json Nuevo sitio 11 months ago
.gitignore Nuevo sitio 11 months ago
.markdownlint.json Nuevo sitio 11 months ago
.markdownlintignore Nuevo sitio 11 months ago
.stylelintignore Nuevo sitio 11 months ago
.stylelintrc.json Nuevo sitio 11 months ago
CHANGELOG.md Nuevo sitio 11 months ago
CODE_OF_CONDUCT.md Nuevo sitio 11 months ago
LICENSE Nuevo sitio 11 months ago
README.md Nuevo sitio 11 months ago
SECURITY.md Nuevo sitio 11 months ago
babel.config.js Nuevo sitio 11 months ago
netlify.toml Nuevo sitio 11 months ago
package-lock.json Nuevo sitio 11 months ago
package.json Nuevo sitio 11 months ago
theme.toml Nuevo sitio 11 months ago

README.md

Doks

Doks

Modern Documentation Theme

Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.

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

Doks — Modern Documentation Theme

Demo

Why Doks?

Nine main 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 5. Easily customize your Doks site with the source Sass files.

  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.

Other features

  • Multilingual and i18n support
  • Versioning documentation support
  • KaTeX math typesetting
  • Mermaid diagrams and visualization
  • highlight.js syntax highlighting

Requirements

Doks uses npm to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts:

  • 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

Doks is available as a child theme, and a starter theme:

  • Use the Doks child theme, if you do not plan to customize a lot, and/or need future Doks updates.
  • Use the Doks starter theme, if you plan to customize a lot, and/or do not need future Doks updates.

Not quite sure? Use the Doks child theme.

Doks child theme

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

Doks starter theme

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

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

OC sponsor 0

Backers

Support this project by becoming a backer. Your avatar will show up here.

Backers