portails/content/docs/prologue/introduction.md

89 lines
2.9 KiB
Markdown
Raw Normal View History

2020-04-15 15:48:16 +02:00
---
title: "Introduction"
2020-11-05 16:53:02 +01:00
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."
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: []
2020-04-15 15:48:16 +02:00
menu:
docs:
parent: "prologue"
weight: 010
toc: true
---
2020-11-05 16:53:02 +01:00
## Why Doks?
2020-04-15 15:48:16 +02:00
2020-11-10 08:31:21 +01:00
Nine reasons why you should use Doks:
2020-04-15 15:48:16 +02:00
2020-11-05 16:53:02 +01:00
1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.
2020-11-04 08:26:58 +01:00
2020-11-05 17:04:14 +01:00
2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637) by default. Doks removes unused css, prefetches links, and lazy loads images.
2020-11-04 08:26:58 +01:00
3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.
5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap. Or use any other front-end framework if you prefer.
6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.
2020-11-10 08:31:21 +01:00
7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.
8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.
9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.
2020-11-05 16:53:02 +01:00
## Requirements
2020-04-15 15:48:16 +02:00
2020-04-17 11:15:31 +02:00
Make sure all dependencies have been installed:
2020-04-15 15:48:16 +02:00
2020-11-05 16:53:02 +01:00
- [Hugo](https://gohugo.io/) >= 0.75.0/extended
- [Node.js](https://nodejs.org/) >= 14.15.0 (needed to install npm packages and run commands)
2020-04-15 15:48:16 +02:00
2020-04-17 11:15:31 +02:00
## Get started
2020-04-15 15:48:16 +02:00
2020-11-05 16:53:02 +01:00
Create a new Doks project:
2020-04-15 15:48:16 +02:00
```bash
2020-11-05 16:53:02 +01:00
git clone https://github.com/h-enk/doks.git my-doks-site
2020-11-04 08:26:58 +01:00
```
2020-11-05 16:53:02 +01:00
Install npm packages:
2020-11-04 08:26:58 +01:00
```bash
2020-11-05 21:09:30 +01:00
npm install
2020-11-04 08:26:58 +01:00
```
2020-11-05 16:53:02 +01:00
Start local development server:
2020-11-04 08:26:58 +01:00
```bash
2020-11-05 21:09:30 +01:00
npm run start
2020-04-15 15:48:16 +02:00
```
2020-11-05 16:53:02 +01:00
### Other commands
2020-04-15 15:48:16 +02:00
2020-11-05 21:09:30 +01:00
Doks comes with [commands for most used tasks]({{< ref "commands" >}}).
2020-04-15 15:48:16 +02:00
2020-11-05 16:53:02 +01:00
## Quick start
2020-04-15 15:48:16 +02:00
2020-11-05 16:53:02 +01:00
Get your Doks site in 1 min.
2020-04-15 15:48:16 +02:00
2020-11-05 16:53:02 +01:00
<a class="btn btn-primary btn-sm px-3" href="https://app.netlify.com/start/deploy?repository=https://github.com/h-enk/doks" role="button">Deploy to Netlify</a>
2020-11-04 08:26:58 +01:00
2020-11-05 16:53:02 +01:00
## Example site
2020-11-04 08:26:58 +01:00
2020-11-05 16:53:02 +01:00
👉 [doks.netlify.app](https://doks.netlify.app/)
2020-11-04 08:26:58 +01:00
2020-11-05 16:53:02 +01:00
## Documentation
2020-11-04 08:26:58 +01:00
2020-11-05 16:53:02 +01:00
- [Netlify](https://docs.netlify.com/)
- [Hugo](https://gohugo.io/documentation/)
- [Doks](https://getdoks.org/)
2020-11-04 08:26:58 +01:00
2020-11-05 16:53:02 +01:00
## Communities
2020-04-15 15:48:16 +02:00
2020-11-05 16:53:02 +01:00
- [Netlify Community](https://community.netlify.com/)
- [Hugo Forums](https://discourse.gohugo.io/)