Browse Source

Merge pull request '[ADD] create README.md' (#1) from add_readme into master

Reviewed-on: https://git.myceliandre.fr/njeudy/hugo-from-hedgedoc/pulls/1
master
StephanSainleger 2 years ago
parent
commit
5de6f0242f
  1. 42
      README.md

42
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
```
Loading…
Cancel
Save