-
Notifications
You must be signed in to change notification settings - Fork 284
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc/README.md: Improve the Hugo Quick start guide for an easier start
Signed-off-by: Bernhard Kaindl <[email protected]>
- Loading branch information
1 parent
6af8250
commit ab02111
Showing
1 changed file
with
7 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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". |