Giter Club home page Giter Club logo

Comments (5)

Gerrit0 avatar Gerrit0 commented on August 15, 2024 1

TypeDoc supports partial patching of theme partials - you generally aren't supposed to replace every template since then your theme won't benefit from any fixes introduced in TypeDoc.

https://github.com/TypeStrong/typedoc/tree/master/src/lib/output/themes/default/partials contains (for the most part, somewhat refactored) the JSX equivalent as the original handlebars.

from typedoc-custom-theme-demo.

Aleksandyr avatar Aleksandyr commented on August 15, 2024

@Gerrit0 please give more documentation for converting a custom theme to functional JSX template theme

from typedoc-custom-theme-demo.

Aleksandyr avatar Aleksandyr commented on August 15, 2024

@Gerrit0 thanks for sending that.
I see that my CSS is not included in the static site at the end, my assets folder is not the one I ship with my custom theme which is an npm package.

What I am doing is I am having the same structure as the old default theme. Some of the partial templates, default layouts, and the index have been transferred to the jsx template as it was suggested.

In my default layout I am generating my main.css which is in the assets folder but the problem here is that my assets folder is not generated as it is in the package that is installed. It is getting the default structure of it which leads to missing my main.css file.

from typedoc-custom-theme-demo.

Aleksandyr avatar Aleksandyr commented on August 15, 2024

I have managed to pass my custom styles through --customCss option and now I am trying to figure out how I can include all my custom js scripts into the main.js folder or how I can transfer them into the assets folder that is generated by typedoc.

from typedoc-custom-theme-demo.

Gerrit0 avatar Gerrit0 commented on August 15, 2024

For custom themes, I'd recommend adding a listener to app.renderer.on(RendererEvent.END, which will receive a RendererEvent, you can then copy data to event.outputDirectory after checking that the app.renderer.theme instanceof YourTheme

from typedoc-custom-theme-demo.

Related Issues (1)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.