search

mipatterson / typedoc-plugin-pages

A TypeDoc plugin that lets you integrate your own pages into the documentation output
Apache License 2.0
37 stars 21 forks source link

Finish custom theme docs? #31

Closed tanepiper closed 3 years ago

tanepiper commented 3 years ago

I'm looking to use the theme typedoc-theme-neo with my docs and would like to include changelogs as pages using this plugin.

Currently the docs only support the pages theme, and the documentation for custom themes is not finished https://github.com/mipatterson/typedoc-plugin-pages/blob/develop/docs-source/themes/custom-themes.md

Attempted to integrate the two, but it breaks output and does not generate docs.

loopingz commented 3 years ago

You can look at that one: https://github.com/mipatterson/typedoc-plugin-pages/pull/32

I started a typedoc-loopingz-theme based on typedoc-neo-theme that have this available but include also some redesign: https://cluster.static.loopingz.com/webda.io-docs/index.html if you want to see a demo

If it can help you

tanepiper commented 3 years ago

@loopingz Hey, I've tried it out and so far looks great but I've had issues getting the pages working to look like yours, I assume some custom styling? I see you haven't released it though?

loopingz commented 3 years ago

I did release: npm I'm still going under heavy development as I will probably add some custom plugin to add UML diagram and a few more things I did a PR to get the title from .md directly: https://github.com/mipatterson/typedoc-plugin-pages/pull/33 and plan to add a few more customizations. I might have to do a full fork if the current maintainer is busy as I would like to move forward quickly.

Do not hesitate to contact me if you have issue, or even create issue in the theme repository: https://github.com/loopingz/typedoc-loopingz-theme

tanepiper commented 3 years ago

@loopingz Great thanks, I'll probably have some tickets but will also see what I can PR

mipatterson commented 3 years ago

@tanepiper I'm currently finishing up validating the latest TypeDoc releases against this plugin. (I've got a couple of flaky UI tests to work though.) Once that is done I was planning on publishing a new release. I'll take a look at @loopingz's PR and see if I can get some documentation around custom theme's in place as a part of that release.