Export raw docs

Currently crystal docs generates an index.json file, which has markdown already converted to HTTP entities. It makes the docs depend on Crystal’s built-in markdown parser, which is not perfect. I wonder if it is possible to emit raw docs instead (just like in the code)?

I also noted that docs emit links (source_link) tied to github, and it’s kinda magic for me. Does it read from .git directory? Shouldn’t it be more abstract?

In general, I’d like to see docs command to only gather the information of types and methods across the program and emit it in raw but structured format, which can be interpreted differently afterwards.

My use-case is building an alternative VueJS-powered API front-end.

2 Likes

Yes, I think that’s where we should be heading.

I thought the json export format did that… Output the markdown docs instead of the html.