Is your feature request related to a problem? Please describe.
Currently, my descriptions in ms_descriptions are in Markdown, because I tried to use SchemaSpy to document databases. And I tried SchemaSpy it because it supports markdown in descriptions.
Now I tried to document these databases with sp_doc
, but the result in unusable when I include to document the ms_description: The markdown from the descriptions interfere with the generated markdown.
I don't know if it would be possible to "nest" markdown. But I am afraid, this is not possible. But maybe there could be an option to keep the content of the markdown descriptions as they are, but to mark them as code?
Of course there are also code blocks inside the markdown descriptions, and it looks like this will not work, because markdown has no clear syntax to mark the end of some code block:
## markdown description
bla bla bla
select a
from b
and some line after the code
I could use a language marker for the inner code, but again, markdown interpreter will not find detect this as nested code.
## markdown description
bla bla bla
```sql
select a
from b
and some line after the code
Describe the solution you'd like
- An alternative would be an option to generate asciidoc files as an alternative to markdown.
The Syntax would allow nested code, GitHub and some other sites support not only markdown, but also asciidoc.
- An option to include the description as code could help.
If not using code blocks in the description then the outer usage of code block could work.
- Maybe the code marker could be "escaped" in any useful way. It looks note fine, but it would not interfere with the main part of the documentation:
## markdown description
bla bla bla
'```
select a
from b
'```
and some line after the code
Describe alternatives you've considered
To exclude the descriptions from documentation. But it makes no sense to have a full documentation in markdown in the descriptions and not to use it.