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

Github wiki firendly ? #118

Closed
GuichaouaT opened this issue Apr 10, 2020 · 4 comments
Closed

Github wiki firendly ? #118

GuichaouaT opened this issue Apr 10, 2020 · 4 comments

Comments

@GuichaouaT
Copy link

Is there any way to make the docs Github wiki friendly ?
I tried to upload the generated docs to my repo wiki, but it's seems that github wiki cannot manage subfolders.

Is there any option or script I can run to convert the generated docs ?

I read this #47 but I'm not sure to undertand how to solve the problem.

@AZMCode
Copy link

AZMCode commented Jul 31, 2020

They basically didn't solve it, which is kinda sad

@AZMCode
Copy link

AZMCode commented Jul 31, 2020

They're using a custom post-processing script but I'm finding it difficult to make it work

@tgreyuk
Copy link
Member

tgreyuk commented Oct 14, 2020

If this is still of interest I have created a theme that exports to a compatible file structure and also creates a Sidebar.md file.

https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-github-wiki-theme

@AZMCode
Copy link

AZMCode commented Oct 14, 2020

Absolutely it is, I'll try it out sometime!

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

3 participants