127 lines
3.8 KiB
Markdown
127 lines
3.8 KiB
Markdown
---
|
|
title: "Introduction"
|
|
description: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
|
lead: "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
|
|
date: 2020-10-06T08:48:57+00:00
|
|
lastmod: 2020-10-06T08:48:57+00:00
|
|
draft: false
|
|
images: []
|
|
menu:
|
|
docs:
|
|
parent: "prologue"
|
|
weight: 100
|
|
toc: true
|
|
---
|
|
|
|
## Shortcode
|
|
|
|
{{< details "Markdown and HTML" >}}
|
|
_Markdown_ and <em>HTML</em> will be rendered.
|
|
{{< /details >}}
|
|
|
|
{{< details "Unordered list" >}}
|
|
|
|
- step 1
|
|
- step 2
|
|
|
|
{{< /details >}}
|
|
|
|
{{< details "Ordered list" >}}
|
|
|
|
1. step 1
|
|
2. step 2
|
|
3. step 3
|
|
|
|
{{< /details >}}
|
|
|
|
{{< details "Parent" >}}
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
{{< details "Child" >}}
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
{{< details "Grandchild" >}}
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
{{< /details >}}
|
|
{{< /details >}}
|
|
{{< /details >}}
|
|
|
|
{{< details "Start in open state" open >}}
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
{{< /details >}}
|
|
|
|
{{< details "Headings" >}}
|
|
|
|
## Heading 2
|
|
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
|
|
### Heading 3
|
|
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
|
|
#### Heading 4
|
|
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
{{< /details >}}
|
|
|
|
{{< details "<span class=\"fw-bold\">Custom HTML styled summary</span>" >}}
|
|
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
|
|
{{< /details >}}
|
|
|
|
{{< details "Code" >}}
|
|
Paragraph before code block
|
|
|
|
```bash
|
|
npm run create [path] [flags]
|
|
```
|
|
|
|
Paragraph after code block
|
|
{{< /details >}}
|
|
|
|
## 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/)
|
|
|
|
## Help
|
|
|
|
Get help on Doks. [Help →]({{< relref "how-to-update" >}})
|