diff --git a/content/docs/help/_index.md b/content/docs/help/_index.md deleted file mode 100644 index bc503ec..0000000 --- a/content/docs/help/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/content/docs/help/faq.md b/content/docs/help/faq.md deleted file mode 100644 index 826586b..0000000 --- a/content/docs/help/faq.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -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/) -- [Doks Discussions](https://github.com/h-enk/doks/discussions) - -## Contact the creator? - -Send `h-enk` a message: - -- [Netlify Community](https://community.netlify.com/) -- [Hugo Forums](https://discourse.gohugo.io/) -- [Doks Discussions](https://github.com/h-enk/doks/discussions) diff --git a/content/docs/help/how-to-update.md b/content/docs/help/how-to-update.md deleted file mode 100644 index f9bb36b..0000000 --- a/content/docs/help/how-to-update.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -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." />}} - -## Check for outdated packages - -The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated: - -```bash -npm outdated [[<@scope>/] ...] -``` - -## Update packages - -The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver: - -```bash -npm update [...] -``` diff --git a/content/docs/help/troubleshooting.md b/content/docs/help/troubleshooting.md deleted file mode 100644 index 0d52dbb..0000000 --- a/content/docs/help/troubleshooting.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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/content/docs/prologue/_index.md b/content/docs/prologue/_index.md deleted file mode 100644 index c3c1c40..0000000 --- a/content/docs/prologue/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -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/content/docs/prologue/commands.md b/content/docs/prologue/commands.md deleted file mode 100644 index e647a98..0000000 --- a/content/docs/prologue/commands.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -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`." />}} - -## create - -Create new content for your site: - -```bash -npm run create [path] [flags] -``` - -See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/). - -## lint - -Check scripts, styles, and markdown for errors: - -```bash -npm run lint -``` - -### scripts - -Check scripts for errors: - -```bash -npm run lint:scripts [-- --fix] -``` - -### styles - -Check styles for errors: - -```bash -npm run lint:styles [-- --fix] -``` - -### markdown - -Check markdown for errors: - -```bash -npm run lint:markdown [-- --fix] -``` - -## clean - -Delete temporary directories: - -```bash -npm run clean -``` - -## start - -Start local development server: - -```bash -npm run start -``` - -## build - -Build production website: - -```bash -npm run build -``` - -### functions - -Build Lambda functions: - -```bash -npm run build:functions -``` - -### preview - -Build production website including draft and future content: - -```bash -npm run build:preview -``` diff --git a/content/docs/prologue/introduction.md b/content/docs/prologue/introduction.md deleted file mode 100644 index f215533..0000000 --- a/content/docs/prologue/introduction.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -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 →]({{< relref "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/breadcrumb-navigation/) - -### Showcase - -See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/) - -## Contributing - -Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/) - -## Help - -Get help on Doks. [Help →]({{< relref "how-to-update" >}}) diff --git a/content/docs/prologue/quick-start.md b/content/docs/prologue/quick-start.md deleted file mode 100644 index 9282d3e..0000000 --- a/content/docs/prologue/quick-start.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -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 - -Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts: - -- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. - -## Start a new Doks project - -Create a new site, change directories, install dependencies, and start development server. - -### Create a new site - -Doks is available as a child theme, and a starter theme: - -- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates. -- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates. - -Not quite sure? Use the Doks child theme. - -#### Doks child theme - -```bash -git clone https://github.com/h-enk/doks-child-theme.git my-doks-site -``` - -#### Doks starter theme - -```bash -git clone https://github.com/h-enk/doks.git my-doks-site -``` - -### Change directories - -```bash -cd my-doks-site -``` - -### Install dependencies - -```bash -npm install -``` - -### Start development server - -```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 →]({{< relref "commands" >}})