-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Dirk Müller <[email protected]>
- Loading branch information
1 parent
ff0f4c7
commit 4b72e1b
Showing
1 changed file
with
20 additions
and
12 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,41 +1,49 @@ | ||
# openela.org website | ||
|
||
The openela.org website is managed using `Hugo`. You can install it using your favorite package manager. | ||
The openela.org website is managed using `Hugo`. You can install it using | ||
your favorite package manager. | ||
|
||
## Setup | ||
|
||
Ensure you have the "Extended" version of Hugo, which includes features required by this repository. | ||
Ensure you have the "Extended" version of Hugo, which includes features | ||
required by this repository. | ||
|
||
### Linux | ||
|
||
Hugo is available in many package managers (but not EPEL, yet). Downloading the latest release binary from github is an easy option. | ||
Hugo is available in many package managers (but not EPEL, yet). Downloading | ||
the latest release binary from github is an easy option. | ||
|
||
### Mac | ||
|
||
`brew install go` | ||
`brew install hugo` | ||
`brew install sass/sass/sass` | ||
`brew install go` | ||
`brew install hugo` | ||
`brew install sass/sass/sass` | ||
|
||
## Building locally | ||
|
||
To build the static site to the `public/` folder (i.e., for release) run `hugo`. | ||
To build the static site to the `public/` folder (i.e., for release) run | ||
`hugo`. | ||
|
||
To run hugo in server mode and view the site in real time on your computer as you make updates, run `hugo server` | ||
To run hugo in server mode and view the site in real time on your computer as | ||
you make updates, run `hugo server` | ||
|
||
By default this will run the service locally on http://localhost:1313/ | ||
By default this will run the service locally on http://localhost:1313/ | ||
|
||
## Adding Content | ||
|
||
To add new content to the site, decide what type of content it is (announcement, blog, news), and run | ||
To add new content to the site, decide what type of content it is | ||
(announcement, blog, news), and run | ||
|
||
``` | ||
hugo new content content/<type>/Post-Title-Separated-By-Dashes.md | ||
``` | ||
|
||
For example, to create a new Blog post titled "My First Blog" with the url /blog/my-first-blog, you'd run | ||
For example, to create a new Blog post titled "My First Blog" with the url | ||
/blog/my-first-blog, you'd run | ||
|
||
``` | ||
hugo new content content/blog/my-first-blog.md | ||
``` | ||
|
||
Then, open the file and edit as required. Make sure to set the post to *not* be a draft before publishing it. | ||
Then, open the file and edit as required. Make sure to set the post to *not* | ||
be a draft before publishing it. |