|
| 1 | +# Docs for fullstack-devops.github.io |
1 | 2 |
|
2 | | -## Demo |
| 3 | +s |
| 4 | +## Run local |
3 | 5 |
|
4 | | -- [doks.netlify.app](https://doks.netlify.app/) |
| 6 | +### Installation |
5 | 7 |
|
6 | | -## Why Doks? |
7 | | - |
8 | | -Nine main reasons why you should use Doks: |
9 | | - |
10 | | -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. |
11 | | - |
12 | | -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. |
13 | | - |
14 | | -3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking. |
15 | | - |
16 | | -4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually. |
17 | | - |
18 | | -5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files. |
19 | | - |
20 | | -6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers. |
21 | | - |
22 | | -7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking. |
23 | | - |
24 | | -8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs. |
25 | | - |
26 | | -9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding. |
27 | | - |
28 | | -### Other features |
29 | | - |
30 | | -- __Multilingual and i18n__ support |
31 | | -- __Versioning__ documentation support |
32 | | -- __KaTeX__ math typesetting |
33 | | -- __Mermaid__ diagrams and visualization |
34 | | -- __highlight.js__ syntax highlighting |
35 | | - |
36 | | -## Requirements |
37 | | - |
38 | | -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: |
39 | | - |
40 | | -- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. |
41 | | - |
42 | | -## Get started |
43 | | - |
44 | | -Start a new Doks project in three steps: |
45 | | - |
46 | | -### 1. Create a new site |
47 | | - |
48 | | -Doks is available as a child theme, and a starter theme: |
49 | | - |
50 | | -- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates. |
51 | | -- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates. |
52 | | - |
53 | | -Not quite sure? Use the Doks child theme. |
54 | | - |
55 | | -#### Doks child theme |
56 | | - |
57 | | -```bash |
58 | | -git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site |
59 | | -``` |
60 | | - |
61 | | -#### Doks starter theme |
| 8 | +install `mkdocs` if not aready done |
62 | 9 |
|
63 | 10 | ```bash |
64 | | -git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site |
| 11 | +pip install mkdocs |
65 | 12 | ``` |
66 | 13 |
|
67 | | -### 2. Install dependencies |
| 14 | +install all required plugins |
68 | 15 |
|
69 | 16 | ```bash |
70 | | -npm install |
| 17 | +python3 setup.py |
71 | 18 | ``` |
72 | 19 |
|
73 | | -### 3. Start development server |
| 20 | +run and watch deployment |
74 | 21 |
|
75 | 22 | ```bash |
76 | | -npm run start |
| 23 | +mkdocs serve |
77 | 24 | ``` |
78 | | - |
79 | | -## Other commands |
80 | | - |
81 | | -Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks. |
82 | | - |
83 | | -## Documentation |
84 | | - |
85 | | -- [Netlify](https://docs.netlify.com/) |
86 | | -- [Hugo](https://gohugo.io/documentation/) |
87 | | -- [Doks](https://getdoks.org/) |
88 | | - |
89 | | -## Communities |
90 | | - |
91 | | -- [Netlify Community](https://community.netlify.com/) |
92 | | -- [Hugo Forums](https://discourse.gohugo.io/) |
93 | | -- [Doks Discussions](https://github.com/h-enk/doks/discussions) |
0 commit comments