Add CITATION.cff file

[drupol]

Hello,

I frequently need to cite Typst in the documents I write, and noticed that GitHub supports a specific citation file format (CITATION.cff). Having this file would enhance the visibility and proper citation of Typst directly from the GitHub repository page.

GitHub's support for the CITATION.cff files enables easy access to citation information, which can be automatically parsed and displayed on the project page. More details can be found in the GitHub documentation on citation files.

Would you be interested in adding such a file to the project?

When Github detect such a file in a repo, a new link is displayed on the right side:

Clicking on the link open a box:

Screenshots from https://github.com/citation-file-format/citation-file-format

Related to #4108

[drupol]

See it lively at https://github.com/drupol/typst/tree/add-citation-cff

[xkevio]

Would it also maybe make sense to add the date-released field? As like the year the repository went public? It's not ideal, especially once Typst is out of beta but citing something without some form of year can look off in most citation styles.

[drupol]

Would it also maybe make sense to add the date-released field? As like the year the repository went public? It's not ideal, especially once Typst is out of beta but citing something without some form of year can look off in most citation styles.

Yes ! The more field we have, the better ! feel free to suggest them !!!

[xkevio]

Would it also maybe make sense to add the date-released field? As like the year the repository went public? It's not ideal, especially once Typst is out of beta but citing something without some form of year can look off in most citation styles.

Yes ! The more field we have, the better ! feel free to suggest them !!!

On that note, the version field could be nice but would have to be updated alongside releases.

[drupol]

The date-released field is usually used when we add the versions inside that file. TBH, I don't believe we should add the versions, therefore, I don't think this field is really needed.

[drupol]

I applied your suggestions, and also added a new CI file to check the validity of the CITATION.cff file.

[laurmaedje]

I think CI for a citation file is overkill, so I'd rather not have that. 🙂

[drupol]

Removed

[laurmaedje]

Thanks!