Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@signalwire/typedoc-readme-api-theme

Package Overview
Dependencies
Maintainers
3
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@signalwire/typedoc-readme-api-theme

An extension of typedoc-plugin-markdown to create a compatible file structure for Readme API pages.

  • 0.3.0
  • npm
  • Socket score

Version published
Maintainers
3
Created
Source

[WiP] typedoc-readme-api-theme

A Readme.com compatible TypeDoc plugin. Extended and adapted from typedoc-github-wiki-theme.

What it does?

  • Generates Readme.com friendly file names.
  • Updates internal urls to a compatible format.
  • Fixes readme-specific quirks in the Markdown flavor

Installation

npm install typedoc @signalwire/typedoc-readme-api-theme --save-dev

Keywords

FAQs

Package last updated on 03 Sep 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc