diff --git a/exampleSite/config/_default/config.toml b/exampleSite/config/_default/config.toml new file mode 100644 index 000000000..dd5cfb68c --- /dev/null +++ b/exampleSite/config/_default/config.toml @@ -0,0 +1,93 @@ +baseurl = "/" +disableAliases = true +disableHugoGeneratorInject = true +enableEmoji = true +enableGitInfo = false +enableRobotsTXT = true +languageCode = "en-US" +paginate = 7 +rssLimit = 10 + +# add redirects/headers +[outputs] +home = ["HTML", "RSS", "REDIRECTS", "HEADERS"] +section = ["HTML", "SITEMAP"] + +# remove .{ext} from text/netlify +[mediaTypes."text/netlify"] +suffixes = [""] +delimiter = "" + +# add output format for netlify _redirects +[outputFormats.REDIRECTS] +mediaType = "text/netlify" +baseName = "_redirects" +isPlainText = true +notAlternative = true + +# add output format for netlify _headers +[outputFormats.HEADERS] +mediaType = "text/netlify" +baseName = "_headers" +isPlainText = true +notAlternative = true + +# add output format for section sitemap.xml +[outputFormats.SITEMAP] +mediaType = "application/xml" +baseName = "sitemap" +isHTML = false +isPlainText = true +noUgly = true +rel = "sitemap" + +[markup] + [markup.goldmark] + [markup.goldmark.extensions] + linkify = false + [markup.goldmark.renderer] + unsafe = true + [markup.highlight] + codeFences = true + guessSyntax = false + hl_Lines = "" + lineNoStart = 1 + lineNos = false + lineNumbersInTable = true + noClasses = false + style = "dracula" + tabWidth = 4 + +[sitemap] + changefreq = "weekly" + filename = "sitemap.xml" + priority = 0.5 + +[taxonomies] + contributor = "contributors" + +[permalinks] + blog = "/blog/:title/" + +[module] + [[module.mounts]] + source = "assets" + target = "assets" + [[module.mounts]] + source = "static" + target = "static" + [[module.mounts]] + source = "node_modules/lazysizes" + target = "assets/js/vendor/lazysizes" + [[module.mounts]] + source = "node_modules/instant.page" + target = "assets/js/vendor/instant.page" + [[module.mounts]] + source = "node_modules/lazysizes" + target = "assets/js/vendor/lazysizes" + [[module.mounts]] + source = "node_modules/flexsearch" + target = "assets/js/vendor/flexsearch" + [[module.mounts]] + source = "node_modules/clipboard" + target = "assets/js/vendor/clipboard" diff --git a/exampleSite/config/_default/menus.toml b/exampleSite/config/_default/menus.toml new file mode 100644 index 000000000..b9ae367f9 --- /dev/null +++ b/exampleSite/config/_default/menus.toml @@ -0,0 +1,39 @@ +[[docs]] + name = "Prologue" + weight = 10 + identifier = "prologue" + url = "/docs/prologue/" + +[[docs]] + name = "Help" + weight = 60 + identifier = "help" + url = "/docs/help/" + +[[main]] + name = "Docs" + url = "/docs/prologue/introduction/" + weight = 10 + +[[main]] + name = "Blog" + url = "/blog/" + weight = 20 + +# [[social]] +# name = "Twitter" +# pre = "" +# url = "https://twitter.com/gethyas" +# weight = 10 + +[[social]] + name = "GitHub" + pre = "" + url = "https://github.com/h-enk/doks" + post = "v0.1.0" + weight = 20 + +# [[footer]] +# name = "Privacy" +# url = "/privacy-policy/" +# weight = 10 diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml new file mode 100644 index 000000000..4e039e174 --- /dev/null +++ b/exampleSite/config/_default/params.toml @@ -0,0 +1,47 @@ +# Meta Data for SEO + +## Homepage +title = "Doks" +titleSeparator = "-" +titleAddition = "Modern Documentation Theme" +description = "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." + +## Open Graph + Twitter Cards +images = ["doks.png"] +twitterSite = "henkverlinde" +twitterCreator = "henkverlinde" +facebookAuthor = "verlinde.henk" +facebookPublisher = "verlinde.henk" +ogLocale = "en_US" + +## JSON-LD +schemaType = "Organization" +schemaLogo = "logo-doks.png" +schemaTwitter = "https://twitter.com/henkverlinde" +schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/" +schemaGitHub = "https://github.com/h-enk" +schemaSection = "blog" + +## Sitelinks Search Box +siteLinksSearchBox = false + +## Chrome Browser +themeColor = "#fff" + +# Images +quality = 85 +bgColor = "#fff" +landscapePhotoWidths = [900, 800, 700, 600, 500] +portraitPhotoWidths = [800, 700, 600, 500] +lqipWidth = "20x" + +# Footer +footer = "Powered by Netlify, Hugo, and Doks" + +# Alert +alert = false +alertText = "Like Doks? Star on GitHub. Thanks!" + +# Edit Page +docsRepo = "https://github.com/h-enk/doks" +editPage = false diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md new file mode 100644 index 000000000..db4b8c439 --- /dev/null +++ b/exampleSite/content/_index.md @@ -0,0 +1,9 @@ +--- +title : "Modern Documentation Theme" +description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +date: 2020-10-06T08:47:36+00:00 +lastmod: 2020-10-06T08:47:36+00:00 +draft: false +images: [] +--- diff --git a/exampleSite/content/blog/_index.md b/exampleSite/content/blog/_index.md new file mode 100644 index 000000000..37cb611db --- /dev/null +++ b/exampleSite/content/blog/_index.md @@ -0,0 +1,8 @@ +--- +title: "Blog" +description: "The Doks Blog." +date: 2020-10-06T08:49:55+00:00 +lastmod: 2020-10-06T08:49:55+00:00 +draft: false +images: [] +--- diff --git a/exampleSite/content/blog/say-hello-to-doks/index.md b/exampleSite/content/blog/say-hello-to-doks/index.md new file mode 100644 index 000000000..e9c31858c --- /dev/null +++ b/exampleSite/content/blog/say-hello-to-doks/index.md @@ -0,0 +1,11 @@ +--- +title: "Say hello to Doks 👋" +description: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +lead: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +date: 2020-11-04T09:19:42+01:00 +lastmod: 2020-11-04T09:19:42+01:00 +draft: false +weight: 50 +images: ["say-hello-to-doks.png"] +contributors: ["Henk Verlinde"] +--- diff --git a/exampleSite/content/blog/say-hello-to-doks/say-hello-to-doks.png b/exampleSite/content/blog/say-hello-to-doks/say-hello-to-doks.png new file mode 100644 index 000000000..70d8c7861 Binary files /dev/null and b/exampleSite/content/blog/say-hello-to-doks/say-hello-to-doks.png differ diff --git a/exampleSite/content/contributors/_index.md b/exampleSite/content/contributors/_index.md new file mode 100644 index 000000000..e225f3442 --- /dev/null +++ b/exampleSite/content/contributors/_index.md @@ -0,0 +1,10 @@ +--- +title: "Contributors" +description: "The Doks contributors." +date: 2020-10-06T08:50:29+00:00 +lastmod: 2020-10-06T08:50:29+00:00 +draft: false +images: [] +--- + +The Doks contributors. diff --git a/exampleSite/content/contributors/henk-verlinde/_index.md b/exampleSite/content/contributors/henk-verlinde/_index.md new file mode 100644 index 000000000..f775534e0 --- /dev/null +++ b/exampleSite/content/contributors/henk-verlinde/_index.md @@ -0,0 +1,12 @@ +--- +title: "Henk Verlinde" +description: "Creator of Hyas." +date: 2020-10-06T08:50:45+00:00 +lastmod: 2020-10-06T08:50:45+00:00 +draft: false +images: [] +--- + +Creator of Hyas. + +[@HenkVerlinde](https://twitter.com/henkverlinde) diff --git a/exampleSite/content/docs/_index.md b/exampleSite/content/docs/_index.md new file mode 100644 index 000000000..f807c6528 --- /dev/null +++ b/exampleSite/content/docs/_index.md @@ -0,0 +1,9 @@ +--- +title : "Docs" +description: "Docs Doks." +lead: "" +date: 2020-10-06T08:48:23+00:00 +lastmod: 2020-10-06T08:48:23+00:00 +draft: false +images: [] +--- diff --git a/exampleSite/content/docs/help/_index.md b/exampleSite/content/docs/help/_index.md new file mode 100644 index 000000000..bc503ecf4 --- /dev/null +++ b/exampleSite/content/docs/help/_index.md @@ -0,0 +1,9 @@ +--- +title: "Help" +description: "Help Doks." +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: false +images: [] +--- diff --git a/exampleSite/content/docs/help/faq.md b/exampleSite/content/docs/help/faq.md new file mode 100644 index 000000000..25e74444a --- /dev/null +++ b/exampleSite/content/docs/help/faq.md @@ -0,0 +1,48 @@ +--- +title: "FAQ" +description: "Answers to frequently asked questions." +lead: "Answers to frequently asked questions." +date: 2020-10-06T08:49:31+00:00 +lastmod: 2020-10-06T08:49:31+00:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 630 +toc: true +--- + +## Hyas? + +Doks is a [Hyas theme](https://gethyas.com/themes/) build by the creator of Hyas. + +## Footer notice? + +Please keep it in place. + +## Keyboard shortcuts for search? + +- focus: `/` +- select: `↓` and `↑` +- open: `Enter` +- close: `Esc` + +## Other documentation? + +- [Netlify](https://docs.netlify.com/) +- [Hugo](https://gohugo.io/documentation/) + +## Can I get support? + +Create a topic: + +- [Netlify Community](https://community.netlify.com/) +- [Hugo Forums](https://discourse.gohugo.io/) + +## Contact the creator? + +Send `h-enk` a message: + +- [Netlify Community](https://community.netlify.com/) +- [Hugo Forums](https://discourse.gohugo.io/) diff --git a/exampleSite/content/docs/help/how-to-update.md b/exampleSite/content/docs/help/how-to-update.md new file mode 100644 index 000000000..0129cdcd0 --- /dev/null +++ b/exampleSite/content/docs/help/how-to-update.md @@ -0,0 +1,24 @@ +--- +title: "How to Update" +description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." +lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." +date: 2020-11-12T13:26:54+01:00 +lastmod: 2020-11-12T13:26:54+01:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 610 +toc: true +--- + +{{< alert icon="💡" text="Learn more about semantic versioning and advanced range syntax." >}} + +## Update npm packages + +Bump the versions in the `devDependencies` section of `./package.json` to your liking, and run: + +```bash +npm update +``` diff --git a/exampleSite/content/docs/help/troubleshooting.md b/exampleSite/content/docs/help/troubleshooting.md new file mode 100644 index 000000000..0d52dbb17 --- /dev/null +++ b/exampleSite/content/docs/help/troubleshooting.md @@ -0,0 +1,30 @@ +--- +title: "Troubleshooting" +description: "Solutions to common problems." +lead: "Solutions to common problems." +date: 2020-11-12T15:22:20+01:00 +lastmod: 2020-11-12T15:22:20+01:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 620 +toc: true +--- + +## Problems updating npm packages + +Delete the `./node_modules` folder, and run again: + +```bash +npm install +``` + +## Problems with cache + +Delete the temporary directories: + +```bash +npm run clean +``` diff --git a/exampleSite/content/docs/prologue/_index.md b/exampleSite/content/docs/prologue/_index.md new file mode 100644 index 000000000..c3c1c40bc --- /dev/null +++ b/exampleSite/content/docs/prologue/_index.md @@ -0,0 +1,9 @@ +--- +title : "Prologue" +description: "Prologue Doks." +lead: "" +date: 2020-10-06T08:48:45+00:00 +lastmod: 2020-10-06T08:48:45+00:00 +draft: false +images: [] +--- diff --git a/exampleSite/content/docs/prologue/commands.md b/exampleSite/content/docs/prologue/commands.md new file mode 100644 index 000000000..b5818d16e --- /dev/null +++ b/exampleSite/content/docs/prologue/commands.md @@ -0,0 +1,106 @@ +--- +title: "Commands" +description: "Doks comes with commands for common tasks." +lead: "Doks comes with commands for common tasks." +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 130 +toc: true +--- + +{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." >}} + +## start + +Start local development server: + +{{< btn-copy text="npm run start" >}} + +```bash +npm run start +``` + +## lint + +Check scripts, styles, and markdown for errors: + +{{< btn-copy text="npm run lint" >}} + +```bash +npm run lint +``` + +### scripts + +Check scripts for errors: + +{{< btn-copy text="npm run lint:scripts" >}} + +```bash +npm run lint:scripts [-- --fix] +``` + +### styles + +Check styles for errors: + +{{< btn-copy text="npm run lint:styles" >}} + +```bash +npm run lint:styles [-- --fix] +``` + +### markdown + +Check markdown for errors: + +{{< btn-copy text="npm run lint:markdown" >}} + +```bash +npm run lint:markdown [-- --fix] +``` + +## clean + +Delete temporary directories: + +{{< btn-copy text="npm run clean" >}} + +```bash +npm run clean +``` + +## build + +Build production website: + +{{< btn-copy text="npm run build" >}} + +```bash +npm run build +``` + +### functions + +Build Lambda functions: + +{{< btn-copy text="npm run build:functions" >}} + +```bash +npm run build:functions +``` + +### preview + +Build production website including draft and future content: + +{{< btn-copy text="npm run build:preview" >}} + +```bash +npm run build:preview +``` diff --git a/exampleSite/content/docs/prologue/introduction.md b/exampleSite/content/docs/prologue/introduction.md new file mode 100644 index 000000000..29f47b50e --- /dev/null +++ b/exampleSite/content/docs/prologue/introduction.md @@ -0,0 +1,58 @@ +--- +title: "Introduction" +description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +date: 2020-10-06T08:48:57+00:00 +lastmod: 2020-10-06T08:48:57+00:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 100 +toc: true +--- + +## Get started + +There are two main ways to get started with Doks: + +### Tutorial + +{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." >}} + +Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/) + +### Quick Start + +{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." >}} + +One page summary of how to start a new Doks project. [Quick Start →]({{< ref "quick-start" >}}) + +## Go further + +Recipes, Reference Guides, Extensions, and Showcase. + +### Recipes + +Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/) + +### Reference Guides + +Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/) + +### Extensions + +Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/add-google-fonts/) + +### Showcase + +See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/causal-data-science-meeting/) + +## Contributing + +Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/) + +## Help + +Get help on Doks. [Help →]({{< ref "how-to-update" >}}) diff --git a/exampleSite/content/docs/prologue/quick-start.md b/exampleSite/content/docs/prologue/quick-start.md new file mode 100644 index 000000000..1ba482554 --- /dev/null +++ b/exampleSite/content/docs/prologue/quick-start.md @@ -0,0 +1,65 @@ +--- +title: "Quick Start" +description: "One page summary of how to start a new Doks project." +lead: "One page summary of how to start a new Doks project." +date: 2020-11-16T13:59:39+01:00 +lastmod: 2020-11-16T13:59:39+01:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 110 +toc: true +--- + +## Requirements + +{{< alert icon="👉" text="Node.js is needed to install npm packages and run commands." >}} + +Make sure all dependencies have been installed: + +- [Hugo](https://gohugo.io/getting-started/installing/) >= 0.75.0/extended +- [Node.js](https://nodejs.org/) >= 14.15.0 + +## Start a new Doks project + +Create a new site, change directories, install npm packages, and start development server. + +### Create a new site + +{{< btn-copy text="git clone https://github.com/h-enk/doks.git my-doks-site" >}} + +```bash +git clone https://github.com/h-enk/doks.git my-doks-site +``` + +### Change directories + +{{< btn-copy text="cd my-doks-site" >}} + +```bash +cd my-doks-site +``` + +### Install npm packages + +{{< btn-copy text="npm install" >}} + +```bash +npm install +``` + +### Start development server + +{{< btn-copy text="npm run start" >}} + +```bash +npm run start +``` + +Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser. + +## Other commands + +Doks comes with commands for common tasks. [Commands →]({{< ref "commands" >}}) diff --git a/exampleSite/static/android-chrome-192x192.png b/exampleSite/static/android-chrome-192x192.png new file mode 100644 index 000000000..03a0e7022 Binary files /dev/null and b/exampleSite/static/android-chrome-192x192.png differ diff --git a/exampleSite/static/android-chrome-512x512.png b/exampleSite/static/android-chrome-512x512.png new file mode 100644 index 000000000..74bdfb9da Binary files /dev/null and b/exampleSite/static/android-chrome-512x512.png differ diff --git a/exampleSite/static/apple-touch-icon.png b/exampleSite/static/apple-touch-icon.png new file mode 100644 index 000000000..225acef1b Binary files /dev/null and b/exampleSite/static/apple-touch-icon.png differ diff --git a/exampleSite/static/css/vendor/.gitkeep b/exampleSite/static/css/vendor/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/exampleSite/static/doks.png b/exampleSite/static/doks.png new file mode 100644 index 000000000..70d8c7861 Binary files /dev/null and b/exampleSite/static/doks.png differ diff --git a/exampleSite/static/favicon-16x16.png b/exampleSite/static/favicon-16x16.png new file mode 100644 index 000000000..8fcd42236 Binary files /dev/null and b/exampleSite/static/favicon-16x16.png differ diff --git a/exampleSite/static/favicon-32x32.png b/exampleSite/static/favicon-32x32.png new file mode 100644 index 000000000..21378a4cb Binary files /dev/null and b/exampleSite/static/favicon-32x32.png differ diff --git a/exampleSite/static/favicon.ico b/exampleSite/static/favicon.ico new file mode 100644 index 000000000..9e2fc8d4d Binary files /dev/null and b/exampleSite/static/favicon.ico differ diff --git a/exampleSite/static/fonts/vendor/.gitkeep b/exampleSite/static/fonts/vendor/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500.woff b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500.woff new file mode 100644 index 000000000..eab8d1b68 Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500.woff differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500.woff2 b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500.woff2 new file mode 100644 index 000000000..92349d19c Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500.woff2 differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500italic.woff b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500italic.woff new file mode 100644 index 000000000..7a8ed959e Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500italic.woff differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500italic.woff2 b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500italic.woff2 new file mode 100644 index 000000000..c6b9d56e9 Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-500italic.woff2 differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700.woff b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700.woff new file mode 100644 index 000000000..57390f51a Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700.woff differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700.woff2 b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700.woff2 new file mode 100644 index 000000000..584073a80 Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700.woff2 differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700italic.woff b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700italic.woff new file mode 100644 index 000000000..e23eedf07 Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700italic.woff differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700italic.woff2 b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700italic.woff2 new file mode 100644 index 000000000..e56d892a6 Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-700italic.woff2 differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-italic.woff b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-italic.woff new file mode 100644 index 000000000..5dcd11159 Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-italic.woff differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-italic.woff2 b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-italic.woff2 new file mode 100644 index 000000000..9346c1d2a Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-italic.woff2 differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-regular.woff b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-regular.woff new file mode 100644 index 000000000..4f24758df Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-regular.woff differ diff --git a/exampleSite/static/fonts/vendor/jost/jost-v4-latin-regular.woff2 b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-regular.woff2 new file mode 100644 index 000000000..7f0bf7556 Binary files /dev/null and b/exampleSite/static/fonts/vendor/jost/jost-v4-latin-regular.woff2 differ diff --git a/exampleSite/static/images/vendor/.gitkeep b/exampleSite/static/images/vendor/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/exampleSite/static/js/vendor/.gitkeep b/exampleSite/static/js/vendor/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/exampleSite/static/logo-doks.png b/exampleSite/static/logo-doks.png new file mode 100644 index 000000000..74bdfb9da Binary files /dev/null and b/exampleSite/static/logo-doks.png differ diff --git a/exampleSite/static/site.webmanifest b/exampleSite/static/site.webmanifest new file mode 100644 index 000000000..d641eb716 --- /dev/null +++ b/exampleSite/static/site.webmanifest @@ -0,0 +1 @@ +{"name":"Doks Theme","short_name":"Doks","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#fff","background_color":"#fff","display":"standalone"} \ No newline at end of file diff --git a/images/screenshot.png b/images/screenshot.png new file mode 100644 index 000000000..5849cbbb3 Binary files /dev/null and b/images/screenshot.png differ diff --git a/images/tn.png b/images/tn.png new file mode 100644 index 000000000..54bb92896 Binary files /dev/null and b/images/tn.png differ diff --git a/theme.toml b/theme.toml new file mode 100644 index 000000000..b526d1d36 --- /dev/null +++ b/theme.toml @@ -0,0 +1,12 @@ +name = "Doks" +license = "MIT" +licenselink = "https://github.com/h-enk/doks/blob/master/LICENSE" +description = "Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +homepage = "https://getdoks.org/" +tags = ["landing page", "documentation", "blog", "minimal", "modern", "customizable", "search", "dark mode", "bootstrap"] +features = ["security aware", "fast by default", "seo-ready", "development tools", "bootstrap framework", "netlify-ready", "full text search", "page layouts", "dark mode"] +min_version = "0.75.0" + +[author] + name = "Henk Verlinde" + homepage = "https://henkverlinde.com/"