-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
define the narrative sections as being Markdown? #13
Comments
I think the markdown is a vestige to make the gitbook look nice. It should probably be taken out now that that schema supports text and keys in the narrative section. Thoughts? |
18F/compliance-toolkit#25 is around making the |
@afeld yeah the idea is for now to stick to using plain text for now in order to get compatibility for both gitbook and docx. we might have to create some universal tags (sounds painful) that can be inserted and then transform it to the appropriate syntax for the specific output |
Sounds good. Thanks! |
Reopening, since the text is parsed by GitBook as Markdown. |
Would seem that full support for Markdown might be more then its worth but at the same time things like:
are heavily used/relied on for creating sensible documentation via rendered markdown to html and/or in docx formats those would seem worth the time to investigate and inform the time/resources for each as a potential lift to support |
For the cloud.gov compliance, we are putting Markdown formatting in the
narrative
sections (maybe more)...should we say in the schema that Markdown is supported in that field?The text was updated successfully, but these errors were encountered: