2023-06-16 12:00:05 +02:00
|
|
|
|
2021-01-24 21:02:03 +01:00
|
|
|
|
|
|
|
|
<p align="center">
|
2023-06-16 12:00:05 +02:00
|
|
|
<br/>
|
|
|
|
|
<a href="https://getdoks.org/">Doks</a> is a theme for building custom, production-ready documentation websites.
|
|
|
|
|
<br/>
|
|
|
|
|
Powered by <a href="https://gethyas.com/">Hyas</a> — the all-in-one Hugo framework designed for ease of use.
|
|
|
|
|
<br/><br/>
|
2021-01-24 21:02:03 +01:00
|
|
|
</p>
|
|
|
|
|
|
2020-12-07 10:33:24 +01:00
|
|
|
## Demo
|
|
|
|
|
|
|
|
|
|
- [doks.netlify.app](https://doks.netlify.app/)
|
|
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
## Key Features
|
2020-11-04 15:07:07 +01:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
- **Hugo powered:** Fast and flexible framework for building websites.
|
|
|
|
|
- **Project dependencies**: Install and update dependencies easier with [npm](https://www.npmjs.com/).
|
|
|
|
|
- **Production-ready**: Optimized for speed, SEO, and security.
|
|
|
|
|
- **Customizable:** Build the website you want with settings and integrations.
|
|
|
|
|
- **Development tools:** Check scripts, styles, and markdown for errors.
|
|
|
|
|
- **Deploy anywhere:** Deployment guides to different deployment services.
|
2020-11-10 08:31:21 +01:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
Check out our detailed [Why Doks](https://getdoks.org/concepts/why-doks/) breakdown to learn more about what makes Doks special. ✨
|
2021-10-05 10:35:25 +02:00
|
|
|
|
2021-01-19 08:11:59 +01:00
|
|
|
## Requirements
|
2021-01-18 16:05:33 +01:00
|
|
|
|
2023-06-17 15:53:53 +02:00
|
|
|
- [Node.js](https://nodejs.org/) — `v16.12.0` or higher
|
2020-11-04 15:07:07 +01:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
## Install
|
2021-04-02 19:15:06 +02:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
The recommended way to install the latest version of Doks is by running the command below:
|
2020-11-04 15:07:07 +01:00
|
|
|
|
|
|
|
|
```bash
|
2023-06-16 12:00:05 +02:00
|
|
|
npm create hyas@latest -- --template doks
|
2020-11-04 15:07:07 +01:00
|
|
|
```
|
|
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
Looking for help? Start with our [Getting Started](https://getdoks.org/docs/start-here/getting-started/) guide.
|
2020-11-04 15:07:07 +01:00
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
Visit our [official documentation](https://getdoks.org/).
|
2020-11-04 15:07:07 +01:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
## Support
|
2020-11-04 15:07:07 +01:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
Having trouble? Get help in the official [Doks Discussions](https://github.com/h-enk/doks/discussions).
|
2021-10-05 10:35:25 +02:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
## Contributing
|
2021-10-05 10:35:25 +02:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
New contributors welcome! Check out our [Contributor Guides](https://getdoks.org/contribute/) for help getting started.
|
2021-10-05 10:35:25 +02:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
## Links
|
2021-10-05 10:35:25 +02:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
- [License (MIT)](LICENSE)
|
2023-06-17 15:53:53 +02:00
|
|
|
- [Code of Conduct](https://github.com/gethyas/.github/blob/main/CODE_OF_CONDUCT.md)
|
|
|
|
|
- [Project Funding](.github/FUNDING.md)
|
2023-06-16 12:00:05 +02:00
|
|
|
- [Website](https://getdoks.org/)
|
2021-10-05 10:35:25 +02:00
|
|
|
|
2023-06-16 12:00:05 +02:00
|
|
|
## Sponsors
|
2021-10-05 10:35:25 +02:00
|
|
|
|
2023-06-17 15:53:53 +02:00
|
|
|
Doks is supported by Netlify, Algolia, and several other amazing organizations and inidviduals. [Sponsor Doks!](.github/FUNDING.md) ❤️
|
