From ab021110908716cb32e9fc995c95ff129efe0b6d Mon Sep 17 00:00:00 2001 From: Bernhard Kaindl Date: Mon, 17 Jun 2024 12:00:00 +0200 Subject: [PATCH] doc/README.md: Improve the Hugo Quick start guide for an easier start Signed-off-by: Bernhard Kaindl --- doc/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/README.md b/doc/README.md index 9ca0e69c4c1..01879806e59 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,13 +1,17 @@ Quick start guide: +- Visit https://xapi-project.github.io/new-docs/ to view the current documentation. - Install Hugo; follow the guidance on https://gohugo.io/getting-started/installing. You'll need Go as well: see https://go.dev/ + - On Ubuntu 22.04 and older, use `sudo snap install hugo` to get the needed newer version of `hugo`. - Run a local server: `hugo server` -- Open a browser at http://127.0.0.1:1313/ -- Add some content. +- Open a browser at http://127.0.0.1:1313/new-docs/ +- Add content to `doc/content/`: - Documents are written in Markdown. - Please wrap lines in paragraphs to make review and diffs easier to read. - The menu hierarchy comes mostly from the directory structure in `content/`. - - A file called `_index.md` is needed in a directory to define a new level in the menu. Add a title to the frontmatter. + - A file called `_index.md` is needed in a directory to define a new level in the menu. + - To set the page title which is also used for the main menu, + [use the front matter](https://gohugo.io/content-management/front-matter/). - For a page that has images or other stuff included, it is best to create a new directory. Put the contents in a `index.md` file (no `_`) and the related files next to it. See https://gohugo.io/content-management/organization/ for more information. - Look at https://mcshelby.github.io/hugo-theme-relearn/ for more information about what the Relearn theme offers, including some handy "shortcodes".