TypeDoc vs Weave.jl
TypeDoc
typedoc.orgWeave.jl
weavejl.mpastell.comSide by side
| Figure | TypeDoc | Weave.jl |
|---|---|---|
| Price from | Free | — |
| Free plan | Yes | — |
| Free trial | — | — |
| Open source | — | — |
| Linux | Yes | — |
| API | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 0 |
| Spec score · Documentation Generators | 8.0 (#10) | 5.9 (#34) |
| Installation | TypeDoc runs on Node.js and is available as an npm package. | The README gives Julia's package manager as the installation method, using Pkg.add("Weave"). |
| Integrations | The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes. | The documentation describes publishing through Julia or Pandoc and editor support in Juno and Visual Studio Code. |
| License | The TypeDoc repository identifies its license as Apache-2.0. | The GitHub repository identifies the project as MIT licensed. |
| Purpose | TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model. | Weave is a scientific report generator and literate programming tool for Julia. |
| Support | The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide. | The README invites users to contribute by opening GitHub issues or submitting pull requests. |
Plans
In their own words
TypeDoc
TypeDoc is a free TypeScript documentation generator that turns source comments into HTML pages or a JSON model. It builds from project exports and follows re-exports, allowing members declared elsewhere to appear in documentation. TSDoc and JSDoc tags are extracted, Markdown is accepted in comments, and fenced code blocks receive Shiki syntax highlighting. HTML and JSON are built in; Markdown output needs a plugin such as typedoc-plugin-markdown. A default theme is included, while plugins can add themes, alter conversion and symbol organization, or change display. Custom CSS and JavaScript can further adjust generated pages. Configuration can come from an options file, package.json, or tsconfig.json. TypeDoc runs on Node.js, uses the TypeScript compiler, and supports the current Node.js LTS or newer. For npm monorepos, the packages entry-point strategy can combine package documentation into one site. The project is Apache-2.0 licensed. Documentation warns that global installation can separate plugins and themes from the intended TypeDoc installation.
Weave.jl
Weave.jl has no write-up on Specifiction yet; its figures are above.