doccy icon indicating copy to clipboard operation
doccy copied to clipboard

How to support Markdown templating

Open jackfranklin opened this issue 12 years ago • 2 comments

It's possible that some may not like Doccy's default Markdown for formatting, and we should make it possible to change this.

I'm envisaging some JSON file that looks something like:

{
  "param": "- `{{name}}` (`{{type}}`): {{description}",
}

But that might become unwieldy quickly...

jackfranklin avatar Nov 23 '13 23:11 jackfranklin

This way, Doccy's formatting could also be defined via these templates, which would be nice. Good to pull the formatting out of being hidden within the JS.

jackfranklin avatar Nov 23 '13 23:11 jackfranklin

I think this example works quite well, the unwieldily issue may never happen and could be addressed in v2 if we need to

jonathan-fielding avatar Nov 25 '13 10:11 jonathan-fielding