Overview

Doks is a modern documentation theme that offers a range of features and benefits for users. With its focus on security, speed, and SEO readiness, Doks provides developers with a framework that delivers high performance and user-friendly documentation websites.

Features

• Security aware: Doks prioritizes security and comes with default security headers that are highly rated by Mozilla Observatory. Users can easily customize these headers to meet their specific security needs.
• Fast by default: Doks ensures fast loading times for documentation websites and achieves a perfect score on Google Lighthouse. It achieves this by removing unused CSS, prefetching links, and lazy loading images.
• SEO-ready: Doks includes sensible defaults for structured data, open graph, and Twitter cards, making it easy to optimize documentation websites for search engines. Users can also customize SEO settings according to their preferences.
• Development tools: Doks provides developers with tools to code confidently. It offers automated checks for styles, scripts, and markdown errors, allowing users to fix issues either automatically or manually.
• Bootstrap framework: Doks is built using the Bootstrap 5 framework, enabling developers to create robust, flexible, and intuitive websites. The theme also provides the option to customize the site using the source Sass files.
• Netlify-ready: Doks comes with sensible defaults for deploying to Netlify. It seamlessly integrates with Netlify Functions, Netlify Redirects, and Netlify Headers, simplifying the deployment process.
• Full text search: Doks offers the ability to search the documentation website using FlexSearch. Users can easily customize the index settings and search options to suit their requirements.
• Page layouts: Doks allows developers to build different types of pages, including landing pages, blogs, and documentation layouts. Custom sections and components can also be added as needed.
• Dark mode: Doks provides a low-light UI with the option to switch to dark mode with a simple click. Users can also customize colors using variables to match their branding.

Installation

To install Doks, follow these steps:

1. Ensure you have the following requirements installed on your system:

   • Git (latest source release)
   • Node.js (latest LTS version or newer, which includes npm for dependency management)

2. Choose between the child theme or the starter theme, based on your level of expertise and customization needs:

   • Child theme: Designed for novice to intermediate users who require minor customizations. It allows for easy updates of npm packages, including Doks.
   • Starter theme: Designed for intermediate to advanced users who need to make major customizations. It also allows for easy updates of npm packages.

3. Install the necessary dependencies for your chosen theme by running the appropriate command:

For the child theme:

npm install @doks/theme-default

For the starter theme:

npm install @doks/theme-starter

4. Start the development server with the following command:

npm run dev

Additional commands for common tasks are available with the Doks package.

Summary

Doks is a modern documentation theme that offers a wide range of features and benefits for developers. From its security-conscious approach to its focus on speed and SEO readiness, Doks provides a comprehensive solution for creating high-performance documentation websites. With its easy installation process and customizable options, Doks is a powerful tool for developers of varying skill levels.