Skip to content
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

Open
afeld opened this issue Jun 7, 2016 · 6 comments
Open

define the narrative sections as being Markdown? #13

afeld opened this issue Jun 7, 2016 · 6 comments

Comments

@afeld
Copy link
Member

afeld commented Jun 7, 2016

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?

@afeld afeld added the question label Jun 7, 2016
@geramirez
Copy link
Member

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?

@afeld
Copy link
Member Author

afeld commented Jun 8, 2016

18F/compliance-toolkit#25 is around making the narrative more structured, but I'm still seeing things like links and ordered lists in those text sections. Maybe just sticking with plain text is ok for now. @jcscottiii Thoughts?

@jcscottiii
Copy link
Member

@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

@afeld
Copy link
Member Author

afeld commented Jun 9, 2016

Sounds good. Thanks!

@afeld afeld closed this as completed Jun 9, 2016
@afeld
Copy link
Member Author

afeld commented Jun 14, 2016

Reopening, since the text is parsed by GitBook as Markdown.

@JJediny
Copy link
Member

JJediny commented Oct 31, 2016

Would seem that full support for Markdown might be more then its worth but at the same time things like:

# Headings ? (maybe not as bold would me enough to sub for headings)
**bold**
*italics*
* bullets 
[link text](hyperlink)
[^1] references
`code`

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

@mogul mogul added the Icebox label Jan 24, 2017
@mogul mogul removed the Icebox label Feb 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants