2023-09-08 17:51:40 +02:00
|
|
|
# Doks
|
2021-01-24 21:02:03 +01:00
|
|
|
|
2023-09-08 17:51:40 +02:00
|
|
|
Doks is a documentation theme for [Hyas](https://gethyas.com/).
|
2021-01-24 21:02:03 +01:00
|
|
|
|
2020-12-07 10:33:24 +01:00
|
|
|
## Demo
|
|
|
|
|
|
|
|
|
|
- [doks.netlify.app](https://doks.netlify.app/)
|
|
|
|
|
|
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) ❤️
|
