npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@droppedcode/typedoc-plugin-relative-includes

v1.0.5

Published

This plugin for typedoc allows the use of relative path in markdown includes.

Downloads

2,055

Readme

Relative includes plugin for typedoc

This plugin for typedoc allows the use of relative path in markdown includes.

This way if you can define a relative (to the current document) path and it will resolve it when creating the documentation.

The path must be relative (starting with ./ or ../) to the current file processed to be included, paths not starting like this will be handled by the original renderer.

How to use

You must define the includes option, this is needed for typedoc to find the files (see: options). This is only needed for typedoc the relative path will be relative to your comment!:

{
  "includes": "src"
}

You can use the relative path (for more example see the test cases on the git):

/**
 * My test class.
 *
 * [[include ./test.md]]
 */
class Test {}

Typedoc

Supports 0.25 (tested with 0.25.2)

For 0.23 see version 1.0.4

For 0.22 see version 1.0.2

If it does not work

Possible reasons:

  • The plugin is not installed
  • Typedoc version is not supported (happens every "major" typedoc release)
  • The file is not there where you think it is (use the --logLevel Verbose command line parameter to see the messages)
  • Wrong file included: because of how typedoc generation works sometimes a determining the path is not so easy, wrong file can be included if there is multiple same named files in the file tree. I have not seen this happen and should't happen, but theoretically it is possible.
  • The [[include: x]] is not included in an md file. Md file does not support include only the comments handled by typedoc (still the file path will be changed by the plugin to be relative to src folder).
  • The plugin option is not used with typedoc.

How to build

  • download the source or clone it
  • npm i
  • npm run build

How to debug

  • npm run test:prep
  • Update the @droppedcode/typedoc-plugin-copy-assets version in tests\typedoc-plugins-example\package.json if needed
  • vscode F5 or debug or run npx typedoc in the tests\typedoc-plugins-example folder