Skip to content

Generate other file type than html #251

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

Closed
MatthieuLebigre opened this issue Jul 7, 2016 · 7 comments
Closed

Generate other file type than html #251

MatthieuLebigre opened this issue Jul 7, 2016 · 7 comments

Comments

@MatthieuLebigre
Copy link

Hi,
First thanks to your great works on this project !
I would like to use it to generate a doc in Markdown. I can do it thanks to the templates, but the file extension is still html, I have no way to change. I do it by renaming the files with a script, but it would be nice to be able to configure the output file extension.

@aciccarello
Copy link
Collaborator

aciccarello commented Jul 7, 2016

@MatthieuLebigre This seems similar to #174 but it sounds like you got further than he did.

To reiterate, it sounds like this RFC is to allow templates to be outputted with different file types.

@MatthieuLebigre
Copy link
Author

Exactly, my goal is to have a complete Markdown documentation generated.

Maybe in the temaplates if we should be able to configure the output somehow, it would be awesome. And the best would be able to mix different output in the same theme : for exemple html and markdown files. (not my need, but could be usefull in the future)

@jonaskello
Copy link

@MatthieuLebigre I'm also looking to create markdown output. Could you provide some info how you made it work?

@MatthieuLebigre
Copy link
Author

Hi @jonaskello
I'm using this theme: [https://www.npmjs.com/package/typedoc-markdown-theme]
Unfortunatly it's not working so well (file extension is still html, link between pages is broken, ...). With a few manual steps, I can generate a doc.
We plan on do something about that (contribute to Typedoc, or a better theme maybe), but for now it's on hold

@jonaskello
Copy link

@MatthieuLebigre Thanks for the info, I'll give it a try!

@Ledragon
Copy link

Ledragon commented Feb 4, 2017

Hi everyone,
Not sure if this is still an active discussion, but if so, I might be interested as well. Being what I am, though, I started doing something on my side before searching the issues...

This is C# (.NET Core), and I am basically parsing the json output by TypeDoc to create markdown files. The result can be seen here. The whole wiki was generated from the json output file, except the Home page and sidebar.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 31, 2018

There is a markdown theme that demonstrates one way to generate .md files instead of .html, typedoc-plugin-markdown. This plugin is advertised in the readme for future searchers to find.

@Gerrit0 Gerrit0 closed this as completed Dec 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants