fix: examples and code-fencing
- Dominant language
- CSS
- Stars
- 9
- Forks
- 12
- Avg merge
- 12h 20m
- Merged PRs (30d)
- 21
Description
- fenced code blocks have the wrong type
- some have no type
- some claim `ini` are actually `text`
- some claim `json` but are actually `jsonc` or `json5` (**_PREFERRED_**)
- json/jsonc/json5 examples are invalid
- some have duplicate keys
- have wrong type
- JSON is either object `{}` or list `[]`
- the examples start in the middle of an object missing the outer border
- some partial examples claim to be complete - missing a note like `// ...`
---
examples:
- should me `text`, not `ini`
https://github.com/CycloneDX/guides/blob/f0c3954e7bef55e22fb7578a1549ea16b5c66c80/CBOM/en/0x60-Linking.md?plain=1#L8-L10
- wrong json - just search for "```json`" and you will find a lot of them. like here
https://github.com/CycloneDX/guides/blob/f0c3954e7bef55e22fb7578a1549ea16b5c66c80/SBOM/en/0x53-Pedigree.md?plain=1#L46-L62
- missing code fence for malformed JSON
https://github.com/CycloneDX/guides/blob/ac8e63884f622f90c4c79d2bbec688bbc61dc11d/MBOM/en/0x30-Use_Case_Software_Simple.md?plain=1#L145-L149
- wrong type of quote-signs:
https://github.com/CycloneDX/guides/blob/ac8e63884f622f90c4c79d2bbec688bbc61dc11d/MBOM/en/0x30-Use_Case_Software_Simple.md?plain=1#L159-L172
- and somanymore
---
a related issue is also, that there is no json5/jsonc syntax in pandoc - so the generated PDFs will not have proper syntax hilighting.
this shall be addressed in a different issue - see https://github.com/CycloneDX/guides/issues/71
**support for JSONC and JSON5 was added**
Contributor guide
Assessment
This issue has not been assessed yet.