jenglish / ssptool

nodejs / express application for working with OpenControl data
MIT License
3 stars 5 forks source link

Support markdown in control descriptions #19

Closed jenglish closed 3 years ago

jenglish commented 3 years ago

Control descriptions in the OpenControl catalogs at https://github.com/opencontrol/standards are in Markdown format. The official schema documentation doesn't prescribe this, but it appears to be a common convention.

ssptool should interpret it as such, the same as it does for control narratives (ref #3).

jenglish commented 3 years ago

Other notes: currently opencontrol/mdparser.js uses typographer: true; this is probably not appropriate for this use case. In particular: typographer option turns (c) into © in itemized lists; there may be other issues as well.

Should stick to strict CommonMark + GFM tables.