Coder Social home page Coder Social logo

Comments (5)

krisztianb avatar krisztianb commented on June 23, 2024

Hi. This sounds a lot like #10 where somebody wanted to have the documentation details of several "things" in one file. Could you check if that is the same thing you are looking for?

from typedoc-plugin-merge-modules.

Zamiell avatar Zamiell commented on June 23, 2024

Yes, it looks to be the same.

from typedoc-plugin-merge-modules.

krisztianb avatar krisztianb commented on June 23, 2024

Well that is out of scope of this plugin as this one only merges module content and not HTML detail pages.

I don't know how familiar you are with how TypeDoc works. It basically does this:

  1. Scan code and create Reflection instances which are objects containing everything that should be documented.
  2. For every Reflection instance it generates a HTML file using a React "template".

So what you are looking for requires the direct manipulation/merging of the HTML files since you can't store the information of several "things" in one Reflection instance. Moreover I'm not sure if that would result in a reasonable output.

from typedoc-plugin-merge-modules.

Zamiell avatar Zamiell commented on June 23, 2024

Ok, thanks, I'll close this issue.

Can I hire you to create typedoc-plugin-merge-pages? You can message me on Discord @ Zamiel#8743

from typedoc-plugin-merge-modules.

krisztianb avatar krisztianb commented on June 23, 2024

I think you are better off merging the modules and leaving the detail pages as they are.
Merging detail pages will most likely break the navigation and the search functionality of TypeDoc.

from typedoc-plugin-merge-modules.

Related Issues (11)

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.