Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nbozon committed Dec 7, 2019
1 parent 577b3c6 commit 4600a6c
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hugo-based website for GRASS GIS
# Hugo theme for GRASS GIS website

## How to build your own

Expand All @@ -16,7 +16,7 @@

hugo

Output HTML is usually generated in a /public directory at the root of the `grass-website` directory
Output HTML generated in the /public directory at the root of the `grass-website` directory

### Run locally

Expand All @@ -34,31 +34,33 @@ View the website running at http://localhost:1313
Content must be created in .md files using markdown syntax. HTML markup can also be mixed with markdown for more advanced content presentation.

Useful resources:
* Hugo [docs](https://gohugo.io/documentation/)
* Markdown [guide](https://www.markdownguide.org/basic-syntax/)
* [Hugo docs](https://gohugo.io/documentation/)
* [Markdown guide](https://www.markdownguide.org/basic-syntax/)

### Add a news item

*Head to the news directory
cd /grass-website/content/news
cd /grass-website/content/news

* Create new md file
sudo nano mynewsitem.md
sudo nano mynewsitem.md

* Add the basic header information for Hugo, at least title, date, layout

* Write content in mardown bellow

* Rebuild if needed
cd ../../
hugo

cd ../../
hugo

* Check result at http://localhost:1313/news/

### Create a new content page

* Head to a content subdirectory, for example the one used for the About section
cd /grass-website/content/about
cd /grass-website/content/about

* Create a new md file using the basic hugo header and markdown syntax
(more info coming soon)
Expand All @@ -75,8 +77,10 @@ cd /grass-website/content/about
weight = 1

* Rebuild if needed
cd ../../
hugo

cd ../../
hugo

* Check result at http://localhost:1313/about/mypage

Expand Down

0 comments on commit 4600a6c

Please sign in to comment.