|
1 | | -<p align="center"> |
2 | | - <a href="https://getdoks.org/"> |
3 | | - <img alt="Doks" src="https://doks.netlify.app/doks.svg" width="60"> |
4 | | - </a> |
5 | | -</p> |
6 | | - |
7 | 1 | <h1 align="center"> |
8 | | - Doks |
| 2 | + The Low Alcohol Beer Lab! |
9 | 3 | </h1> |
10 | 4 |
|
11 | | -<h3 align="center"> |
12 | | - Modern Documentation Theme |
13 | | -</h3> |
14 | | - |
15 | 5 | <p align="center"> |
16 | | - Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize. |
17 | | -</p> |
18 | | - |
19 | | -<p align="center"> |
20 | | - <a href="https://github.com/h-enk/doks/blob/master/LICENSE"> |
21 | | - <img src="https://img.shields.io/github/license/h-enk/doks?style=flat-square" alt="GitHub"> |
22 | | - </a> |
23 | | - <a href="https://github.com/h-enk/doks/releases"> |
24 | | - <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)"> |
25 | | - </a> |
26 | | - <a href="https://www.npmjs.com/package/@hyas/doks"> |
27 | | - <img src="https://img.shields.io/npm/v/@hyas/doks?style=flat-square" alt="npm (scoped)"> |
28 | | - </a> |
29 | | - <a href="https://github.com/h-enk/doks/actions?query=workflow%3A%22Hyas+CI%22"> |
30 | | - <img src="https://img.shields.io/github/workflow/status/h-enk/doks/Hyas%20CI/master?style=flat-square" alt="GitHub Workflow Status (branch)"> |
31 | | - </a> |
32 | | - <a href="https://app.netlify.com/sites/doks/deploys"> |
33 | | - <img src="https://img.shields.io/netlify/8a1009d5-88ac-413e-96ef-3f928674a083?style=flat-square" alt="Netlify"> |
34 | | - </a> |
35 | | -</p> |
36 | | - |
37 | | - |
38 | | - |
39 | | -## Demo |
40 | | - |
41 | | -- [doks.netlify.app](https://doks.netlify.app/) |
42 | | - |
43 | | -## Why Doks? |
44 | | - |
45 | | -Nine main reasons why you should use Doks: |
46 | | - |
47 | | -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. |
48 | | - |
49 | | -2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=59aafe464a68f8bc30b8e9a636d5b053) by default. Doks removes unused css, prefetches links, and lazy loads images. |
50 | | - |
51 | | -3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking. |
52 | | - |
53 | | -4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually. |
54 | | - |
55 | | -5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files. |
56 | | - |
57 | | -6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers. |
58 | | - |
59 | | -7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking. |
60 | | - |
61 | | -8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs. |
62 | | - |
63 | | -9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding. |
64 | | - |
65 | | -### Other features |
66 | | - |
67 | | -- __Multilingual and i18n__ support |
68 | | -- __Versioning__ documentation support |
69 | | -- __KaTeX__ math typesetting |
70 | | -- __Mermaid__ diagrams and visualization |
71 | | -- __highlight.js__ syntax highlighting |
72 | | - |
73 | | -## Requirements |
74 | | - |
75 | | -- [Git](https://git-scm.com/) — latest source release |
76 | | -- [Node.js](https://nodejs.org/) — latest LTS version or newer |
77 | | - |
78 | | -<details> |
79 | | -<summary>Why Node.js?</summary> |
80 | | - |
81 | | -Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts. |
82 | | - |
83 | | -</details> |
84 | | - |
85 | | -## Get started |
86 | | - |
87 | | -Start a new Doks project in three steps: |
88 | | - |
89 | | -### 1. Create a new site |
90 | | - |
91 | | -Doks is available as a child theme and a starter theme. |
92 | | - |
93 | | -#### Child theme |
94 | | - |
95 | | -- Intended for novice to intermediate users |
96 | | -- Intended for minor customizations |
97 | | -- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks) |
98 | | - |
99 | | -```bash |
100 | | -git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site |
101 | | -``` |
102 | | - |
103 | | -#### Starter theme |
104 | | - |
105 | | -- Intended for intermediate to advanced users |
106 | | -- Intended for major customizations |
107 | | -- [Easily update npm packages](https://getdoks.org/docs/help/how-to-update/) |
108 | | - |
109 | | -```bash |
110 | | -git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site |
111 | | -``` |
112 | | - |
113 | | -<details> |
114 | | -<summary>Help me choose</summary> |
115 | | - |
116 | | -Not sure which one is for you? Pick the child theme. |
117 | | - |
118 | | -</details> |
119 | | - |
120 | | -### 2. Install dependencies |
121 | | - |
122 | | -```bash |
123 | | -npm install |
124 | | -``` |
125 | | - |
126 | | -### 3. Start development server |
127 | | - |
128 | | -```bash |
129 | | -npm run start |
130 | | -``` |
131 | | - |
132 | | -## Other commands |
133 | | - |
134 | | -Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks. |
135 | | - |
136 | | -## Documentation |
137 | | - |
138 | | -- [Netlify](https://docs.netlify.com/) |
139 | | -- [Hugo](https://gohugo.io/documentation/) |
140 | | -- [Doks](https://getdoks.org/) |
141 | | - |
142 | | -## Communities |
143 | | - |
144 | | -- [Netlify Community](https://community.netlify.com/) |
145 | | -- [Hugo Forums](https://discourse.gohugo.io/) |
146 | | -- [Doks Discussions](https://github.com/h-enk/doks/discussions) |
147 | | - |
148 | | -## Sponsors |
149 | | - |
150 | | -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. |
151 | | - |
152 | | -[](https://opencollective.com/doks/tiers/sponsor/0/website) |
153 | | -[](https://opencollective.com/doks/tiers/sponsor/1/website) |
154 | | - |
155 | | -## Backers |
156 | | - |
157 | | -Support this project by becoming a backer. Your avatar will show up here. |
158 | | - |
159 | | -[](https://opencollective.com/doks) |
| 6 | + The Low Alcohol Beer Lab aims to document the tools, equipment, and recipes to make excellent low or no alcohol homebrew beer. |
| 7 | +</p> |
0 commit comments