25 February 2025 to 1 March 2025
Building 30.95
Europe/Berlin timezone

CFF2Pages: Expanding Workflows with Markdown Export

26 Feb 2025, 18:00
2h
Audimax Foyer (Building 30.95)

Audimax Foyer

Building 30.95

Str. am Forum 1, 76131 Karlsruhe

Speaker

Jan Bernoth (Universität Potsdam)

Description

cff2pages is a tool that generates HTML files from metadata collected in the Citation File Format (CFF). It can be used to create a static page on GitHub or GitLab Pages to showcase a project. This is particularly useful for small research software projects, offering an easy-to-use workflow that converts machine-readable metadata into human-readable formats for several purposes:
Enhancing Metadata Quality: Displaying metadata in a user-friendly format can encourage contributors to improve metadata quality by allowing them to verify how it appears to others.
Creating a Project Landing Page: This provides a welcoming and accessible entry point for those not directly involved in development, addressing the challenge of navigating a repository.
Centralizing Metadata: Having one place for all metadata reduces the risk of discrepancies across different outputs when multiple pages are generated.
As highlighted at deRSE24 (https://zenodo.org/records/7767509), cff2pages requires further development to broaden its appeal for various use cases. For example, The Carpentries are interested in their workbench for their Open Source training marterial. To support such use cases, we have begun developing an export option to Markdown files. This new workflow and future development plans will be presented in this poster session.

I want to participate in the youngRSE prize no

Primary authors

Jan Bernoth (Universität Potsdam) Toby Hodges (The Carpentries)

Presentation materials

There are no materials yet.