Loading README.md +11 −8 Original line number Diff line number Diff line Loading @@ -3,25 +3,27 @@ [](https://travis-ci.org/github/h-enk/doks) [](https://doks.netlify.app/) Hugo starter helping you build kick-ass documentation websites. Doks is a Hugo starter helping you build modern documentation websites. ## What you get ## Features - Lightweight code base - 100/A+ scores Google Lighthouse and [Mozilla Observatory](https://observatory.mozilla.org/) - 100 scores Google Lighthouse - A+ scores [Mozilla Observatory](https://observatory.mozilla.org/) - [Algolia DocSearch](https://docsearch.algolia.com/) support - Dark/Light toggle - Blog ready - Easily make it your own - All in [Hyas](https://github.com/h-enk/hyas) See a working example at [doks.netlify.app](https://doks.netlify.app/) ## Requirements Make sure all dependencies have been installed: - Hugo >= 0.69.0/extended - Node.js >= 13.11.0 - npm >= 6.13.7 - Yarn >= 1.22.4 (recommended) - [Hugo](https://gohugo.io/) >= 0.69.0/extended - [Node.js](https://nodejs.org/) >= 13.11.0 - [Yarn](https://yarnpkg.com/) >= 1.22.4 (recommended) ## Get started Loading Loading @@ -52,5 +54,6 @@ $ yarn start - `yarn build` - Build production theme ## Documentation - [Hugo](https://gohugo.io/documentation/) - [Hyas](https://gethyas.com/) - [Doks](https://doks.netlify.app/) - [Doks](https://getdoks.org/) config/_default/menus.toml +4 −10 Original line number Diff line number Diff line Loading @@ -5,16 +5,10 @@ url = "/docs/prologue/" [[docs]] name = "Basic Hyas" name = "Help" weight = 20 identifier = "basic-hyas" url = "/docs/basic-hyas/" [[docs]] name = "Styles and assets" weight = 30 identifier = "styles-and-assets" url = "/docs/styles-and-assets/" identifier = "help" url = "/docs/help/" [[main]] name = "Docs" Loading @@ -29,7 +23,7 @@ [[social]] name = "Twitter" pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>" url = "https://twitter.com/henkverlinde" url = "https://twitter.com/getdoks" weight = 10 [[social]] Loading config/_default/params.toml +3 −3 Original line number Diff line number Diff line title = "Doks" titleSeparator = "-" titleAddition = "Hugo Documentation Starter" description = "Hugo starter helping you build kick-ass documentation websites." titleAddition = "Modern Hugo Documentation Starter" description = "Hugo starter helping you build modern documentation websites." images = ["image-doks.png"] twitterSite = "@henkverlinde" twitterCreator = "@henkverlinde" ogLocale = "en_US" schemaType = "Organization" schemaLogo = "logo-doks.png" schemaTwitter = "https://twitter.com/henkverlinde" schemaTwitter = "https://twitter.com/getdoks" schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/" schemaSection = "news" siteLinksSearchBox = false Loading content/_index.md +3 −3 Original line number Diff line number Diff line --- title : "Doks" description: "Hugo starter helping you build kick-ass documentation websites." date: 2019-12-02T13:47:16+01:00 description: "Hugo starter helping you build modern documentation websites." date: 2020-04-17T08:47:36+00:00 draft: false images: [image-doks.png] lead: "Hugo starter helping you build kick-ass documentation websites." lead: "Hugo starter helping you build modern documentation websites." --- <div class="row justify-content-center"> Loading content/authors/_index.md +2 −2 Original line number Diff line number Diff line --- title: "Authors" description: "" date: 2020-03-23T11:01:55+01:00 description: "The Doks Blog authors." date: 2020-04-17T08:50:29+00:00 draft: false images: [image-doks.png] --- Loading Loading
README.md +11 −8 Original line number Diff line number Diff line Loading @@ -3,25 +3,27 @@ [](https://travis-ci.org/github/h-enk/doks) [](https://doks.netlify.app/) Hugo starter helping you build kick-ass documentation websites. Doks is a Hugo starter helping you build modern documentation websites. ## What you get ## Features - Lightweight code base - 100/A+ scores Google Lighthouse and [Mozilla Observatory](https://observatory.mozilla.org/) - 100 scores Google Lighthouse - A+ scores [Mozilla Observatory](https://observatory.mozilla.org/) - [Algolia DocSearch](https://docsearch.algolia.com/) support - Dark/Light toggle - Blog ready - Easily make it your own - All in [Hyas](https://github.com/h-enk/hyas) See a working example at [doks.netlify.app](https://doks.netlify.app/) ## Requirements Make sure all dependencies have been installed: - Hugo >= 0.69.0/extended - Node.js >= 13.11.0 - npm >= 6.13.7 - Yarn >= 1.22.4 (recommended) - [Hugo](https://gohugo.io/) >= 0.69.0/extended - [Node.js](https://nodejs.org/) >= 13.11.0 - [Yarn](https://yarnpkg.com/) >= 1.22.4 (recommended) ## Get started Loading Loading @@ -52,5 +54,6 @@ $ yarn start - `yarn build` - Build production theme ## Documentation - [Hugo](https://gohugo.io/documentation/) - [Hyas](https://gethyas.com/) - [Doks](https://doks.netlify.app/) - [Doks](https://getdoks.org/)
config/_default/menus.toml +4 −10 Original line number Diff line number Diff line Loading @@ -5,16 +5,10 @@ url = "/docs/prologue/" [[docs]] name = "Basic Hyas" name = "Help" weight = 20 identifier = "basic-hyas" url = "/docs/basic-hyas/" [[docs]] name = "Styles and assets" weight = 30 identifier = "styles-and-assets" url = "/docs/styles-and-assets/" identifier = "help" url = "/docs/help/" [[main]] name = "Docs" Loading @@ -29,7 +23,7 @@ [[social]] name = "Twitter" pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>" url = "https://twitter.com/henkverlinde" url = "https://twitter.com/getdoks" weight = 10 [[social]] Loading
config/_default/params.toml +3 −3 Original line number Diff line number Diff line title = "Doks" titleSeparator = "-" titleAddition = "Hugo Documentation Starter" description = "Hugo starter helping you build kick-ass documentation websites." titleAddition = "Modern Hugo Documentation Starter" description = "Hugo starter helping you build modern documentation websites." images = ["image-doks.png"] twitterSite = "@henkverlinde" twitterCreator = "@henkverlinde" ogLocale = "en_US" schemaType = "Organization" schemaLogo = "logo-doks.png" schemaTwitter = "https://twitter.com/henkverlinde" schemaTwitter = "https://twitter.com/getdoks" schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/" schemaSection = "news" siteLinksSearchBox = false Loading
content/_index.md +3 −3 Original line number Diff line number Diff line --- title : "Doks" description: "Hugo starter helping you build kick-ass documentation websites." date: 2019-12-02T13:47:16+01:00 description: "Hugo starter helping you build modern documentation websites." date: 2020-04-17T08:47:36+00:00 draft: false images: [image-doks.png] lead: "Hugo starter helping you build kick-ass documentation websites." lead: "Hugo starter helping you build modern documentation websites." --- <div class="row justify-content-center"> Loading
content/authors/_index.md +2 −2 Original line number Diff line number Diff line --- title: "Authors" description: "" date: 2020-03-23T11:01:55+01:00 description: "The Doks Blog authors." date: 2020-04-17T08:50:29+00:00 draft: false images: [image-doks.png] --- Loading