From 640b2b77be17a8d8a68e1e0be5b9722a10cc7caa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phan=20Sainl=C3=A9ger?= Date: Mon, 12 Dec 2022 15:41:44 +0100 Subject: [PATCH] [ADD] create README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c8282b7 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Hugo from Hedgdoc + +This repository contains code to generate a Hugo website based on markedown files coming from [Hedgedoc](https://hedgedoc.org/). + + +## Install + +### Install Hugo + +Follow the Hugo installation guidelines: https://gohugo.io/installation/ + +### Install Hugo from Hedgedoc + +Clone the current Git repository on your computer. + +## Configure + +### Import the markdown files + +Markdown files must be stored in the repository `content` + +### Customize the theme + +1. Create a repo `themes` + +``` +mkdir themes +``` + +2. Import your code in the repo `themes`, for instance: +``` +cd themes +git clone https://github.com/matcornic/hugo-theme-learn.git +``` + + +## Run your Hugo + +Launch the following command from your local repository: +``` +hugo serve +``` \ No newline at end of file