Hi all,

I am new to that list but I have an urgent question.

We are using Docusaurus as Website-Framework (https://docusaurus.io/) and plan to share assets in Markdown via our new community website.

While adding a copyright header in markdown sounds trivial, we would prefer to not mess up the generated website with all the copyright headers on each page. Thus we need to have a way to “comment” in markdown.

Are there already any good-practices in the reuse-community how to handle this best and that also the reuse-tool is satisfied?

Here is a thread for potential “comments in markdown”:

https://stackoverflow.com/questions/4823468/comments-in-markdown

An example reuse-header could then look like e.g. :

[comment]: <> (SPDX-FileCopyrightText: 2024 copyright owner)

[comment]: <> (SPDX-License-Identifier: GPL-3.0-or-later)

Or

[//]: # (SPDX-FileCopyrightText: 2024 copyright owner)
[//]: # (SPDX-License-Identifier: GPL-3.0-or-later)

Any recommendations? Would that also work with the reuse-tool?

In parallel I try to setup the reuse-tool in order to check how the tool would handle this.

Mit freundlichen Grüßen / Best regards

Marcel Kurzmann

Center of Excellence Open Source and InnerSource (BD/TOA-IDE2)

Senior Expert
Robert Bosch GmbH | Ziegelei 7 | 88090 Immenstaad | GERMANY | www.bosch.com
Tel. +49 7545 202-279 | Mobil +49 172 1499942 | Telefax +49 7545 202-301 | Marcel.Kurzmann@bosch.com

Sitz: Stuttgart, Registergericht: Amtsgericht Stuttgart, HRB 14000;
Aufsichtsratsvorsitzender: Prof. Dr. Stefan Asenkerschbaumer;
Geschäftsführung: Dr. Stefan Hartung, Dr. Christian Fischer, Dr. Markus Forschner,
Stefan Grosch, Dr. Markus Heyn, Dr. Frank Meyer, Dr. Tanja Rückert