From ace1b92284a6575141c3ce6d15a8fd7c3813b0e6 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Thu, 10 Aug 2023 22:07:06 +0100 Subject: [PATCH] docs: Updated badge --- packages/typedoc-plugin-markdown/README.md | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/packages/typedoc-plugin-markdown/README.md b/packages/typedoc-plugin-markdown/README.md index 53b9ff3e6..88f91c1f6 100644 --- a/packages/typedoc-plugin-markdown/README.md +++ b/packages/typedoc-plugin-markdown/README.md @@ -2,7 +2,7 @@ A plugin for [TypeDoc](https://typedoc.org) that renders TypeScript API documentation as Markdown. -[![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg)](https://www.npmjs.com/package/typedoc-plugin-markdown) +![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?style=flat-square&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml) ## What does it do? @@ -11,18 +11,6 @@ By default, TypeDoc will render API documentation as a webpage, e.g. HTML files. The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options. This is useful if documentation is required to be included in project README files, Wikis and static site generators. - - ## Installation **Please note this pre-release version may contain breaking changes within the same semantic version.** @@ -65,6 +53,7 @@ Below is a summary of the available options: + **`--outputFileStrategy`** `"members" | "modules"` > Determines how output files are generated. Defaults to `members`. [more ยป](./docs/usage/options.md#outputfilestrategy)