{"id":20082424,"url":"https://github.com/emoflon/emoflon-website-hugo","last_synced_at":"2026-05-15T22:03:24.718Z","repository":{"id":71711681,"uuid":"515134225","full_name":"eMoflon/emoflon-website-hugo","owner":"eMoflon","description":"Hugo-based website for the eMoflon project.","archived":false,"fork":false,"pushed_at":"2025-02-13T08:10:27.000Z","size":5197,"stargazers_count":1,"open_issues_count":7,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-13T09:24:15.336Z","etag":null,"topics":["emoflon","framework","hugo","static-site-generator","website"],"latest_commit_sha":null,"homepage":"https://emoflon.org","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eMoflon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-18T10:19:20.000Z","updated_at":"2025-02-13T08:10:28.000Z","dependencies_parsed_at":"2025-01-13T01:44:48.928Z","dependency_job_id":"7e046dc7-a217-4794-a4b2-76a6e2eaee88","html_url":"https://github.com/eMoflon/emoflon-website-hugo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eMoflon%2Femoflon-website-hugo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eMoflon%2Femoflon-website-hugo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eMoflon%2Femoflon-website-hugo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eMoflon%2Femoflon-website-hugo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eMoflon","download_url":"https://codeload.github.com/eMoflon/emoflon-website-hugo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241515954,"owners_count":19975140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emoflon","framework","hugo","static-site-generator","website"],"created_at":"2024-11-13T15:43:20.588Z","updated_at":"2025-10-08T13:46:28.467Z","avatar_url":"https://github.com/eMoflon.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# eMoflon hugo website\n\nThis repository holds all content and build-related files for the eMoflon website:\nhttps://emoflon.org\n\nResponsible for deployment and maintainment: Max Kratz \u003c[maximilian.kratz@es.tu-darmstadt.de](mailto:maximilian.kratz@es.tu-darmstadt.de)\u003e\n\n\u003c!--\nTODO\n| Branch | Status |\n| ------ | ------ |\n| Main | [![pipeline status](https://git-ce.rwth-aachen.de/maximilian.kratz/dlz-landing-page/badges/main/pipeline.svg)](https://git-ce.rwth-aachen.de/maximilian.kratz/dlz-landing-page/-/commits/main) |\n--\u003e\n\n- [Development environment](#development-environment)\n    - [Requirements](#requirements)\n    - [Installation of Hugo](#installation-of-hugo)\n    - [Usage of Hugo](#usage-of-hugo)\n    - [Initialization of the project](#initialization-of-the-project)\n- [Gitflow/Workflow](#gitflow/workflow)\n- [Pipeline](#pipeline)\n    - [Custom CI container image](#custom-ci-container-image)\n- [Content related](#content-related)\n- [Miscellaneous](#miscellaneous)\n    - [Theme](#theme)\n    - [Folder structure](#folder-structure)\n    - [External resources](#external-resources)\n\n\n## Development environment\n\nThis web page is built using a *static site generator* [Hugo](https://gohugo.io/).\nYou may look into its documentation [here](https://gohugo.io/documentation/).\n\n### Requirements\n\nFor contributing, you need the following things:\n\n- [Hugo](https://gohugo.io/) for building the page.\n- A git client like [Gitkraken](https://www.gitkraken.com/) for versioning and contributing.\n- At least some write access in this repository.\n\n### Installation of Hugo\n\nPlease follow this (official) [installation guide of Hugo](https://gohugo.io/getting-started/installing/).\n\nThis project uses Hugo version `0.134.2` **extended** or newer.\nPlease notice that some standard packet sources like Debian/Ubuntu **do not provide the minimum required version**.\n\nThe easiest way to get the required version up and running is to download it from [Github](https://github.com/gohugoio/hugo/releases/tag/v0.134.2) and install it by hand.\nDetailed steps for an installation from Github [are described on this page](https://gohugo.io/getting-started/installing/#install-hugo-from-tarball).\n\nIt is important that you can start Hugo from your terminal and that it states the correct version number.\nYou may check it using this command:\n\n```bash\n$ hugo version\nhugo v0.134.2+extended darwin/arm64 BuildDate=2024-09-10T10:46:33Z VendorInfo=brew\n```\n\n**Tip**: Use the exact version stated above to prevent version incompatibilities.\nThis version is also used by our [CI-Pipeline](#pipeline).\n\nRequired downloads may be found here:\n\n* [Github release page](https://github.com/gohugoio/hugo/releases/tag/v0.134.2)\n* [Direct download Linux (deb)](https://github.com/gohugoio/hugo/releases/download/v0.134.2/hugo_extended_0.134.2_linux-amd64.deb)\n* [Direct download Linux (tar)](https://github.com/gohugoio/hugo/releases/download/v0.134.2/hugo_extended_0.134.2_linux-amd64.tar.gz)\n* [Direct download macOS](https://github.com/gohugoio/hugo/releases/download/v0.134.2/hugo_extended_0.134.2_darwin-universal.tar.gz)\n* [Direct download Windows](https://github.com/gohugoio/hugo/releases/download/v0.134.2/hugo_extended_0.134.2_windows-amd64.zip)\n\n### Usage of Hugo\n\nIn addition to the official Hugo documentation, you may find a collection of some useful commands here:\n\n- Build the page with Hugo: `$ hugo`\n- Build the page with Hugo including all *drafts*: `$ hugo -D`\n- Start a local webserver: `$ hugo server --disableFastRender`\n    - `--disableFastRender` is optional.\n    - Hugo serves the page at [http://localhost:1313/](http://localhost:1313/).\n    - Hint: Stop the service with `CTRL+C`.\n- Start a local webserver including all *drafts*: `$ hugo server -D --disableFastRender`\n    - (Additional information as above.)\n\nIf you changed basic configuration parameters of the page, it may be neccessary to restart Hugos webserver completely to reload the configuration file(s).\n\n### Initialization of the project\n\n- Add your SSH key to Github.\n- Clone this git repository to your local workstation and enter the folder.\n- Initialize all submodules, as described [here](#theme).\n- As a test, you may start a local webserver with hugo using `$ hugo server -D --disableFastRender` as command and verify, that the page is accessible using this url: [http://localhost:1313](https://localhost:1313)\n    - Please keep in mind that `-D` enables rendering of *drafts*.\n\n\n## Gitflow/Workflow\n\nThe workflow is heavily based on git-flow.\nA great summary may be found here: [https://nvie.com/posts/a-successful-git-branching-model/](https://nvie.com/posts/a-successful-git-branching-model/)\n\nThis means that the following rules apply in particular:\n\n- **Nobody** pushes directly to *main* branch except for maintainers.\n- For integration of changes, a so-called *feature*-branch has to be created, which is derived from the branch *main*.\n    - A feature branch has to have the name *feature/name-of-the-feature*.\n- For integration of hotfixes, a so-called *hotfix*-branch has to be created, which is derived from the branch *main*.\n    - A hotfix branch has to have the name *hotfix/name-of-the-hotfix*.\n- Once the change (feature or hotfix) is implemented, a *Pull Request* is created, which integrates the Feature-Branch into the branch *main*.\n    - For pull requests, maintainers must always confirm that the changes will be integrated. (Please check the changes and do not just agree on them).\n\nResponsible people should be entered as *responsible* for all issues and pull requests.\n\n\u003c!--\nTODO\nFurthermore, there are so called *labels* which should be assigned to all issues and merge requests.\nThere are two group of labels:\n- *prio*: Priorization e.g. \"nice-to-have\" or \"critical\".\n- *type*: Type e.g. \"content\" or \"documentation\".\n\nPlease assign one label of group *prio* and at least one label of group *type* to all of your issues and merge requests.\n--\u003e\n\n\n\u003c!--\nTODO\n## Pipeline\n\nAll commits on this repository will be processed via a CI pipeline on Github, running on public runners.\nEvery log and result may be read directly in Github, as the runner uploads results, logs and artifacts.\n\nYou can have a look into the configuration file: [.gitlab-ci.yml](.gitlab-ci.yml)\n\n\n## Deployment\n\nTODO\n--\u003e\n\n## Content-related\n\nThis section does not really refer to the content of the site, but to content tips and tricks for Hugo.\n\nIn the markdown pages for Hugo, there is a meta-information section at the top (for official documentation see [here](https://gohugo.io/content-management/front-matter/).).\nThis can look like the following, for example:\n\n```markdown\n---\ntitle: \"New Webpage\"\ndate: 2022-07-18\ndraft: true\n---\n```\n\n**Declarations**\n\n- *title*: Specifies the title of the page.\n- *date*: Here you can explicitly set the \"*last edited on*\".\n- *draft*: If `true`, then this page is a draft and will not be built/published. Locally, Hugo can be instructed by the parameter `D` to include this page(s) anyway.\n\n\n## Miscellaneous\n\nEverything that did not really fit into the other sections.\n\n### Theme\n\nThe theme is the [Cayman Hugo theme](https://github.com/zwbetz-gh/cayman-hugo-theme).\nIt is integrated into the project as *git submodule* and must be initialized after the initial cloning of the repo.\n\n```bash\n$ git submodule update --init --recursive\n```\n\n### Folder structure\n\nThe most important folders and files are listed here:\n\n- [assets/](assets/) files that are processed by Hugo, e.g., css.\n- [content/](content/) Content of the pages, texts, structure etc.\n- [layouts/](layouts/) Own changes and/or extensions, e.g., of the theme.\n- [static/](static/) Static files that should be available on the finished web page in exactly the same way, e.g., images.\n- [themes/](themes/) The theme of the page.\n    - Nothing should be changed here, so that updates of the theme can be easily updated. Any changes belong either in [assets/](assets/) or in [layouts/](layouts/), see [https://wowchemy.com/docs/customization/](here).\n- [sources/](sources/) Source files for future graphics.\n    - You should place all files, which are necessary for the creation of the integrated media, into this folder (e.g., Photoshop documents).\n\u003c!--\nTODO\n- [.gitlab-ci.yml](.gitlab-ci.yml) The CI configuration of the pipeline.\n--\u003e\n- [config.yaml](config.yaml) Configuration of the theme and the site.\n\nThe basic folder structure is described in the [official Hugo documentation](https://gohugo.io/getting-started/directory-structure/).\n\n### External resources\n\nJust a collection of some links, that may be helpful:\n\n- Markdown\n    - [Markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)\n    - [Mastering markdown](https://guides.github.com/features/mastering-markdown/)\n    - [Hugo/Learn markdown](https://gohugo.io/content-management/formats/#learn-markdown)\n- Theme \"Cayman Hugo theme\"\n    - [Github page](https://github.com/zwbetz-gh/cayman-hugo-theme)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femoflon%2Femoflon-website-hugo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femoflon%2Femoflon-website-hugo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femoflon%2Femoflon-website-hugo/lists"}