2021-05-07 16:15:41 +00:00
|
|
|
---
|
|
|
|
|
title: "Introduction"
|
|
|
|
|
description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
|
|
|
|
|
lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
|
|
|
|
|
date: 2020-10-06T08:48:57+00:00
|
|
|
|
|
lastmod: 2020-10-06T08:48:57+00:00
|
|
|
|
|
draft: false
|
|
|
|
|
images: []
|
|
|
|
|
menu:
|
|
|
|
|
docs:
|
2021-05-11 19:40:37 +00:00
|
|
|
parent: "intro"
|
2021-05-07 16:15:41 +00:00
|
|
|
weight: 100
|
|
|
|
|
toc: true
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Get started
|
|
|
|
|
|
|
|
|
|
There are two main ways to get started with Doks:
|
|
|
|
|
|
|
|
|
|
### Tutorial
|
|
|
|
|
|
|
|
|
|
{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." >}}
|
|
|
|
|
|
|
|
|
|
Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/)
|
|
|
|
|
|
|
|
|
|
### Quick Start
|
|
|
|
|
|
|
|
|
|
{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." >}}
|
|
|
|
|
|
|
|
|
|
One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}})
|
|
|
|
|
|
|
|
|
|
## Go further
|
|
|
|
|
|
|
|
|
|
Recipes, Reference Guides, Extensions, and Showcase.
|
|
|
|
|
|
|
|
|
|
### Recipes
|
|
|
|
|
|
|
|
|
|
Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/)
|
|
|
|
|
|
|
|
|
|
### Reference Guides
|
|
|
|
|
|
|
|
|
|
Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/)
|
|
|
|
|
|
|
|
|
|
### Extensions
|
|
|
|
|
|
|
|
|
|
Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/)
|
|
|
|
|
|
|
|
|
|
### Showcase
|
|
|
|
|
|
|
|
|
|
See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/)
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/)
|
