forked from CCCHH/ccchh-website
Create CCCHH theme
This commit is contained in:
parent
8394b08524
commit
2d267ba9fe
23 changed files with 629 additions and 1 deletions
40
README.md
40
README.md
|
@ -22,4 +22,42 @@ All other information like details on groups, projects and recurring events shou
|
|||
|
||||
## Usage
|
||||
|
||||
TODO
|
||||
### Build and Deploy
|
||||
|
||||
Running the hugo command without and parameters will re-generate the site in the `public` directory.
|
||||
To deploy the website, just copy the whole folder to a directory which is servered by the webserver of your preference.
|
||||
|
||||
Please note, that the website should be re-deployed at least daily to update the "announcement" section on the front page even if there were no changed to the content.
|
||||
|
||||
### Add Pages
|
||||
|
||||
To run a local version, just install HUGO by following the [instructions](https://gohugo.io/installation/) for your operating system.
|
||||
To build the website and run a development webserver, execute:
|
||||
```shell
|
||||
hugo server
|
||||
```
|
||||
|
||||
To also build posts in the future or in draft state, run this instead:
|
||||
```shell
|
||||
hugo server -D
|
||||
```
|
||||
|
||||
#### Add an Event Announcement
|
||||
|
||||
There are two basic types of posts: Events and articles.
|
||||
Events will be shown on the home page from their publishing date until they have happened.
|
||||
|
||||
To create a new event blog post, run a command like this:
|
||||
```shell
|
||||
hugo new content --king event blog/your-event-title.md
|
||||
```
|
||||
|
||||
#### Add a Blog Entry
|
||||
|
||||
As mentioned before, you can also create blog posts for things which aren't events.
|
||||
They will only be shown in the "blog" section and posted to the RSS feeds.
|
||||
|
||||
To create a new general blog post, run a command like this:
|
||||
```shell
|
||||
hugo new content --king article blog/your-article-title.md
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue