@@ -6,7 +6,31 @@ Crosswalks are developed in
66[ the main CodeMeta repository] ( https://github.com/codemeta/codemeta ) and are
77periodically synchronised into the website.
88
9- Any issues, requests, or contributions for Crosswalks should go there.
9+ A markdown file must be created on this website before that synchronised
10+ Crosswalk data is displayed. Refer to existing files for examples of the
11+ format. The file must contain the following frontmatter fields:
12+
13+ - ` title ` in the format ` Crosswalk for <target> ` where ` <target> ` is the name
14+ of the system the Crosswalk maps to. It can include spaces and symbols.
15+ - ` image ` in the format ` /img/<filename> ` where ` <filename> ` is the name of
16+ the logo filename, including extension. This file must be added to the
17+ ` /static/img/ ` directory. Do * not* use the source path.
18+
19+ The content after the frontmatter should include a short description of the
20+ target system. A link to the system or its metadata documentation should be
21+ included in this description.
22+
23+ The following code required on the last line of the file, where
24+ ` <source filename> ` is the filename of
25+ [ the Crosswalk source file in the main repository] ( https://github.com/codemeta/codemeta.github.io/tree/master/content/crosswalk ) ,
26+ including spaces and symbols, but _ without_ the extension:
27+
28+ ```
29+ {{% crosswalk name="<source filename>" %}}
30+ ```
31+
32+ Any other issues, requests, or contributions for the content of Crosswalks
33+ should go to the main repository.
1034
1135Please refer to the
1236[ instructions for contributing] ( https://github.com/codemeta/codemeta/?tab=contributing-ov-file )
0 commit comments