CCCHH/ccchh-website
CCCHH/ccchh-website
2
2
Fork 0
Code Issues 3 Pull requests 2 Actions Activity

Docs: Improve readme #34

Merged
jtbx merged 2 commits from feature/readme into main 2024-01-27 22:58:50 +01:00
Conversation 3 Commits 2 Files changed 4 +27 -6
1 changed files with 27 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 4efb689d93 - Show all commits

33
README.md
View file

@ -11,8 +11,8 @@ All other information like details on groups, projects and recurring events shou
- start page (onepager)
* who we are
* announcements aka current blog entry (if in the future)
* visit us -> open chaos + link to wiki for all recurring events
* event calendar
* visit us -> open chaos + link to wiki for all recurring events
* groups, e.g. CTF team, CMS, freifunk, etc.
* directions (map)
- blog, split into:
@ -24,7 +24,7 @@ All other information like details on groups, projects and recurring events shou
### Build and Deploy
To populate the calendar data, please run `fetch-calendar.sh` before running hugo.
To populate the calendar data, please run `./fetch-calendar.sh` before running hugo.
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.
@ -47,26 +47,47 @@ 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.
Events will be shown on the home page from their publishing date until they have happened and shall be used for things which happen at a certain date.
This is not limited to events organized by the CCCHH, but can also be a hint to other events which we think are related to our activities.
To create a new event blog post, run a command like this:
```shell
hugo new content --kind event blog/your-event-title.md
hugo new content --kind event blog/yyyy/yyyy-mm-dd-your-event-title/index.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.
They will only be shown in the "blog" section and posted to the RSS feeds and shall be used for things which are relevant for a longer time.
As we have much more event announcements than articles, finding articles in all blog posts can be quite a challenge.
But using these two categories enables filtering, so that the history of articles is in one list.
To create a new general blog post, run a command like this:
```shell
hugo new content --kind article blog/your-article-title.md
hugo new content --kind article blog/yyyy/yyyy-mm-dd-your-article-title/index.md
```
#### Additional Notes on Events and Articles
By default the first 70 words are shown as a summary on list pages.
Please use `<!--more-->` to manually separate the summary from other post content.
Please prefix your folder name with a date to make browsing the content in the source code easier.
The date in the URL will be taken from the `date` field in the front matter.
Blog posts from before 2024-01-22 were imported from the previous website and have additional front matter data which is not usually needed (e.g. the lastmod value).
When using the commands above, the template shall have evenything you need.
#### Populate the Event Calendar
The event calendar table is filled from the Nextcloud iCal feed.
To add a link on the title text, just add some link to the event's description field.
The first link (something starting with `https://` or `http://`) from anywhere in the text will be taken.
(iCal has a link attribute, but that is not supported by the Nextcloud web UI. So we use the description instead.)
### Icons
You can use solid and brand icons from https://fontawesome.com/icons version 6 in your posts like this: