2023-05-23 14:55:30 +02:00
|
|
|
|
---
|
|
|
|
|
|
title: "Getting Started"
|
|
|
|
|
|
description: ""
|
|
|
|
|
|
summary: ""
|
|
|
|
|
|
date: 2023-05-15T12:16:32+02:00
|
|
|
|
|
|
lastmod: 2023-05-15T12:16:32+02:00
|
|
|
|
|
|
draft: false
|
|
|
|
|
|
images: []
|
|
|
|
|
|
menu:
|
|
|
|
|
|
docs:
|
|
|
|
|
|
parent: ""
|
|
|
|
|
|
identifier: "getting-started-6773eb7de506682cac098bb1a83e1cdf"
|
|
|
|
|
|
weight: 110
|
|
|
|
|
|
toc: true
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## What is Doks?
|
|
|
|
|
|
|
2023-05-26 17:44:05 +02:00
|
|
|
|
Doks is a [Hyas](https://gethyas.com/) theme for building custom, production-ready documentation websites.
|
2023-05-23 14:55:30 +02:00
|
|
|
|
|
|
|
|
|
|
## Key Features
|
|
|
|
|
|
|
|
|
|
|
|
- **Hugo powered:** Fast and flexible framework for building websites.
|
|
|
|
|
|
- **Project dependencies**: Install and update dependencies easier with [npm](https://www.npmjs.com/).
|
|
|
|
|
|
- **Production-ready**: Optimized for speed, SEO, and security.
|
|
|
|
|
|
- **Customizable:** Build the website you want with settings and integrations.
|
|
|
|
|
|
- **Development tools:** Check styles, scripts, and markdown for errors.
|
|
|
|
|
|
- **Deploy anywhere:** Deployment guides to different deployment services.
|
|
|
|
|
|
|
|
|
|
|
|
Check out our detailed [Why Doks](https://getdoks.org/concepts/why-doks/) breakdown to learn more about what makes Doks special. :sparkles:
|
|
|
|
|
|
|
|
|
|
|
|
## Learn Doks
|
|
|
|
|
|
|
|
|
|
|
|
See examples of some of the key concepts and patterns of a Doks site!
|
|
|
|
|
|
|
|
|
|
|
|
- [Add your first page](https://getdoks.org/) to your site.
|
|
|
|
|
|
- Read more about Doks' [project structure](https://getdoks.org/).
|
|
|
|
|
|
- Learn about Doks' [project configuration](https://getdoks.org/).
|
|
|
|
|
|
{ .list-books }
|
|
|
|
|
|
|
|
|
|
|
|
## Extend Doks
|
|
|
|
|
|
|
|
|
|
|
|
- Customize your site with official and community [plugins](https://getdoks.org/integrations/).
|
|
|
|
|
|
- Deploy your site where you want with our [deployment guides](https://getdoks.org/guides/deploy/).
|
|
|
|
|
|
- Get inspired by visiting our site [showcase](https://getdoks.org/showcase/).
|
|
|
|
|
|
{ .list-toolbox }
|
|
|
|
|
|
|
|
|
|
|
|
… see our guide to using [plugins](https://getdoks.org/).
|
|
|
|
|
|
|
|
|
|
|
|
## Join our Community
|
|
|
|
|
|
|
|
|
|
|
|
Join us on [Doks Discussions](https://github.com/h-enk/doks/discussions) to share with and get help from an active, friendly community!
|
|
|
|
|
|
|
|
|
|
|
|
- Say hi in [Introductions](https://github.com/h-enk/doks/discussions/categories/introductions)!
|
|
|
|
|
|
- Ask our Support Squad a question in [Q&A](https://github.com/h-enk/doks/discussions/categories/q-a)!
|
|
|
|
|
|
- Share what you’ve been working on in [Show and tell](https://github.com/h-enk/doks/discussions/categories/show-and-tell)!
|
|
|
|
|
|
{.list-speech-balloon}
|
|
|
|
|
|
|
|
|
|
|
|
## What's New?
|
|
|
|
|
|
|
|
|
|
|
|
- [Doks Blog](https://getdoks.org/blog/)
|
|
|
|
|
|
- [Doks changelog](https://github.com/h-enk/doks/blob/master/CHANGELOG.md)
|
|
|
|
|
|
|
|
|
|
|
|
## Contribute
|
|
|
|
|
|
|
2023-06-17 15:53:53 +02:00
|
|
|
|
New contributors welcome! Check out our [Contributor Guides](https://getdoks.org/contribute/) for help getting started.
|
