portails/README.md

143 lines
4.9 KiB
Markdown
Raw Normal View History

2021-01-24 21:02:03 +01:00
<p align="center">
<a href="https://getdoks.org/">
2021-01-25 09:37:41 +01:00
<img alt="Doks" src="https://doks.netlify.app/doks.svg" width="60">
2021-01-24 21:02:03 +01:00
</a>
</p>
<h1 align="center">
Doks
</h1>
<h3 align="center">
2021-10-05 10:35:25 +02:00
Modern Documentation Theme
2021-01-24 21:02:03 +01:00
</h3>
<p align="center">
2021-10-05 10:35:25 +02:00
Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
2021-01-24 21:02:03 +01:00
</p>
<p align="center">
<a href="https://github.com/h-enk/doks/blob/master/LICENSE">
2021-01-25 09:37:41 +01:00
<img src="https://img.shields.io/github/license/h-enk/doks?style=flat-square" alt="GitHub">
2021-01-24 21:02:03 +01:00
</a>
<a href="https://github.com/h-enk/doks/releases">
2021-01-25 09:37:41 +01:00
<img src="https://img.shields.io/github/v/release/h-enk/doks?include_prereleases&style=flat-square"alt="GitHub release (latest SemVer including pre-releases)">
2021-01-24 21:02:03 +01:00
</a>
2021-10-04 16:50:49 +02:00
<a href="https://www.npmjs.com/package/@hyas/doks">
<img src="https://img.shields.io/npm/v/@hyas/doks?style=flat-square" alt="npm (scoped)">
</a>
2021-01-24 21:02:03 +01:00
<a href="https://github.com/h-enk/doks/actions?query=workflow%3A%22Hyas+CI%22">
2021-01-25 09:37:41 +01:00
<img src="https://img.shields.io/github/workflow/status/h-enk/doks/Hyas%20CI/master?style=flat-square" alt="GitHub Workflow Status (branch)">
2021-01-24 21:02:03 +01:00
</a>
<a href="https://app.netlify.com/sites/doks/deploys">
2021-07-05 15:36:04 +02:00
<img src="https://img.shields.io/netlify/8a1009d5-88ac-413e-96ef-3f928674a083?style=flat-square" alt="Netlify">
2021-01-24 21:02:03 +01:00
</a>
</p>
2020-11-04 15:07:07 +01:00
2020-12-07 11:02:14 +01:00
![Doks — Modern Documentation Theme](https://raw.githubusercontent.com/h-enk/doks/master/images/tn.png)
2020-12-07 10:33:24 +01:00
## Demo
- [doks.netlify.app](https://doks.netlify.app/)
2020-11-04 15:07:07 +01:00
## Why Doks?
2021-10-05 10:35:25 +02:00
Nine main reasons why you should use Doks:
2020-11-04 15:07:07 +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-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 15:07:07 +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.
2021-04-02 19:15:06 +02:00
5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files.
2020-11-04 15:07:07 +01:00
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.
2021-10-05 10:35:25 +02:00
### Other features
- __Multilingual and i18n__ support
- __Versioning__ documentation support
- __KaTeX__ math typesetting
- __Mermaid__ diagrams and visualization
- __highlight.js__ syntax highlighting
2021-01-19 08:11:59 +01:00
## Requirements
2021-01-18 16:05:33 +01:00
2021-04-02 19:15:06 +02:00
Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts:
- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
2020-11-04 15:07:07 +01:00
## Get started
2021-02-01 10:35:23 +01:00
Start a new Doks project in three steps:
2020-12-03 16:07:04 +01:00
2021-02-01 10:35:23 +01:00
### 1. Create a new site
2020-11-04 15:07:07 +01:00
2021-04-02 19:15:06 +02:00
Doks is available as a child theme, and a starter theme:
- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates.
- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates.
Not quite sure? Use the Doks child theme.
#### Doks child theme
```bash
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site
```
#### Doks starter theme
2020-11-04 15:07:07 +01:00
```bash
2021-02-01 10:35:23 +01:00
git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site
2020-11-04 15:07:07 +01:00
```
2021-02-01 10:35:23 +01:00
### 2. Install dependencies
2020-11-04 15:07:07 +01:00
```bash
2020-11-05 21:09:30 +01:00
npm install
2020-11-04 15:07:07 +01:00
```
2021-02-01 10:35:23 +01:00
### 3. Start development server
2020-11-04 15:07:07 +01:00
```bash
2020-11-05 21:09:30 +01:00
npm run start
2020-11-04 15:07:07 +01:00
```
2020-12-03 16:07:04 +01:00
## Other commands
2020-11-04 15:07:07 +01:00
2020-12-03 16:07:04 +01:00
Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks.
2020-11-04 15:07:07 +01:00
## Documentation
- [Netlify](https://docs.netlify.com/)
- [Hugo](https://gohugo.io/documentation/)
- [Doks](https://getdoks.org/)
## Communities
- [Netlify Community](https://community.netlify.com/)
2020-11-04 15:13:11 +01:00
- [Hugo Forums](https://discourse.gohugo.io/)
- [Doks Discussions](https://github.com/h-enk/doks/discussions)
2021-10-05 10:35:25 +02:00
## Sponsors
2021-10-05 10:48:26 +02:00
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
2021-10-05 10:35:25 +02:00
[![OC sponsor 0](https://opencollective.com/doks/sponsor/0/avatar.svg)](https://opencollective.com/doks/sponsor/0/website)
## Backers
2021-10-05 10:49:32 +02:00
Support this project by becoming a backer. Your avatar will show up here.
2021-10-05 10:35:25 +02:00
[![Backers](https://opencollective.com/doks/backers.svg)](https://opencollective.com/doks)