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

Add JSON rendering. #89

Closed
MichaelHatherly opened this issue Jun 8, 2016 · 3 comments
Closed

Add JSON rendering. #89

MichaelHatherly opened this issue Jun 8, 2016 · 3 comments
Labels
Status: Available Type: Feature Type: Plugin A feature that should be implemented as a separate package.

Comments

@MichaelHatherly
Copy link
Member

I came across Elm's JSON output for docs recently: http://package.elm-lang.org/help/docs-preview

Might be interesting to generate JSON as one of the possible outputs at some point.

@mortenpi
Copy link
Member

mortenpi commented Jun 9, 2016

Do you have a specific format (schema?) in mind or should we invent a custom structure for the JSON file?

But a possible application that I would like to see is to have single site with package documentations, including cross package search and references. Then adding a package there could be just a matter of adding a JSON file. It would also decouple the "data" (documentation) from the presentation. I am wondering though.. maybe XML would be more appropriate for this.

@MichaelHatherly
Copy link
Member Author

No format in mind at the moment.

single site with package documentations, including cross package search and references.

Yup, that's the idea, should be possible I think.

@mortenpi mortenpi added the Type: Plugin A feature that should be implemented as a separate package. label Jun 16, 2019
@odow
Copy link
Collaborator

odow commented Oct 31, 2023

I'm doing a triage of open documenter issues and closing issues that are stale. If I've made a mistake, please re-open

Closing as stale. It'd be nice to have everything in a single file for something like MultiDocumenter, but there are too many edge-cases (big heavy assets like images?). We'd also have to define our own schema, which seems like a heavy lift. Also, no one else has asked for this since 2016, so it doesn't seem like a high priority.

@odow odow closed this as completed Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Available Type: Feature Type: Plugin A feature that should be implemented as a separate package.
Projects
None yet
Development

No branches or pull requests

3 participants