nl-design-system / backlog

Central product backlog of the NL Design System.
European Union Public License 1.2
7 stars 1 forks source link

Google Docs to Markdown #18

Closed usethetics closed 1 year ago

usethetics commented 3 years ago

To make our documentation as portable as possible while still retaining the ease of writing in Google Docs we need to investigate an unobtrusive Google Docs to Markdown pipeline.

We can then make sure that documentation in Markdown can live inside of Storybook, next to design files and code implementation.

usethetics commented 3 years ago

I am currently testing Docs to Markdown (GD2md-html). The MD output from this Docs Add-on still needs aftercare and editing here and there.

Another issue is with (inline) code examples. Monospaced text is converted to backticks so it will render as code in Markdown. Google Docs however currently does not support the creation of text styles other than the ones defined bu Docs. Adding backticks manually also works but it means that in order for things like design tokens that we want to render as code there is still some manual work to be done (on the Docs creation side).

usethetics commented 3 years ago

Another possible solution might be to set up a Pandoc conversion process.