An open API service indexing awesome lists of open source software.

https://github.com/thuliteio/doks

Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.
https://github.com/thuliteio/doks

documentation hugo npm static-site static-site-generator theme thulite

Last synced: about 1 month ago
JSON representation

Everything you need to build a stellar documentation website. Fast, accessible, and easy to use.

Awesome Lists containing this project

README

          

# Doks

Doks is a documentation theme for [Thulite](https://thulite.io/).

## Demo

- [doks.netlify.app](https://doks.netlify.app/)

## Features

- Minimal, responsive layout for documentation
- Easy-to-read typography for long-form content
- Fully configurable search powered by FlexSearch
- Dark mode and light mode toggle
- Syntax highlighting for code blocks
- Built-in blog pages
- Internationalization (i18n) support
- Versioning support for managing multiple documentation versions

## Requirements

- Node.js – [latest LTS version](https://nodejs.org/en/download)
- Hugo – [latest extended version](https://github.com/gohugoio/hugo/releases/latest)

## Install

The recommended way to install the latest version of Doks is by running the command below:

```bash
npm create thulite@latest -- --template doks
```

Looking for help? Start with our [Getting Started](https://getdoks.org/docs/start-here/getting-started/) guide.

## Documentation

Visit our [official documentation](https://getdoks.org/).

## Support

Having trouble? Get help in the official [Doks Discussions](https://github.com/thuliteio/doks/discussions).

## Contributing

New contributors welcome! Check out our [Contributor Guides](https://getdoks.org/contribute/) for help getting started.

## Links

- [License (MIT)](LICENSE)
- [Code of Conduct](https://github.com/thuliteio/.github/blob/main/CODE_OF_CONDUCT.md)
- [Project Funding](.github/FUNDING.md)
- [Website](https://getdoks.org/)

## Sponsors

Thulite is free and open-source, thanks to our amazing sponsors. Help keep Thulite sustainable by supporting maintenance, documentation, and long-term development. [Sponsor Thulite](https://github.com/sponsors/thuliteio) ❤️