portails/content/en/docs/prologue/introduction.md

127 lines
3.8 KiB
Markdown
Raw Normal View History

2020-04-15 15:48:16 +02:00
---
title: "Introduction"
2021-10-05 10:35:25 +02:00
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."
2020-11-04 08:26:58 +01:00
date: 2020-10-06T08:48:57+00:00
lastmod: 2020-10-06T08:48:57+00:00
2020-04-15 15:48:16 +02:00
draft: false
2020-11-04 08:26:58 +01:00
images: []
2021-01-01 13:18:53 +01:00
menu:
2020-04-15 15:48:16 +02:00
docs:
parent: "prologue"
2020-12-03 16:07:04 +01:00
weight: 100
2020-04-15 15:48:16 +02:00
toc: true
---
2022-02-09 20:05:13 +01:00
## 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 >}}
2020-12-03 16:07:04 +01:00
## Get started
2020-11-10 08:31:21 +01:00
2020-12-03 16:07:04 +01:00
There are two main ways to get started with Doks:
2020-04-15 15:48:16 +02:00
2020-12-03 16:07:04 +01:00
### Tutorial
2020-04-15 15:48:16 +02:00
{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." />}}
2020-04-15 15:48:16 +02:00
2020-12-03 16:07:04 +01:00
Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/)
2020-04-15 15:48:16 +02:00
2020-12-03 16:07:04 +01:00
### Quick Start
2020-04-15 15:48:16 +02:00
{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." />}}
2020-11-04 08:26:58 +01:00
2021-04-02 19:45:05 +02:00
One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}})
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
## Go further
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
Recipes, Reference Guides, Extensions, and Showcase.
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
### Recipes
2020-04-15 15:48:16 +02:00
2020-12-03 16:07:04 +01:00
Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/)
2020-04-15 15:48:16 +02:00
2020-12-03 16:07:04 +01:00
### Reference Guides
2020-04-15 15:48:16 +02:00
2020-12-03 16:07:04 +01:00
Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/)
2020-04-15 15:48:16 +02:00
2020-12-03 16:07:04 +01:00
### Extensions
2020-04-15 15:48:16 +02:00
2021-04-02 20:01:29 +02:00
Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/)
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
### Showcase
2020-11-04 08:26:58 +01:00
2021-04-02 20:01:29 +02:00
See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/)
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
## Contributing
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/)
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
## Help
2020-04-15 15:48:16 +02:00
2021-04-02 19:45:05 +02:00
Get help on Doks. [Help →]({{< relref "how-to-update" >}})