Skip to content

Commit

Permalink
docs: Updated badge
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Aug 10, 2023
1 parent 91fef83 commit ace1b92
Showing 1 changed file with 2 additions and 13 deletions.
15 changes: 2 additions & 13 deletions packages/typedoc-plugin-markdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand All @@ -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.

<!--
## Quick Links
- [Installation]()
- [Options]()
- [Adding Frontmatter]()
- [Output formatting]()
- [Customizing / extending]()
- [Recipes / demos]()
- [Real life examples]()
-->

## Installation

**Please note this pre-release version may contain breaking changes within the same semantic version.**
Expand Down Expand Up @@ -65,6 +53,7 @@ Below is a summary of the available options:
<!-- DO NOT EDIT THE OPTIONS BELOW DIRECTLY - THEY ARE INJECTED DYNAMICALLY FROM OPTIONS CONFIG -->

<!-- START OPTIONS -->

**`--outputFileStrategy`** `"members" | "modules"`

> Determines how output files are generated. Defaults to `members`. <small>[more »](./docs/usage/options.md#outputfilestrategy)</small>
Expand Down

0 comments on commit ace1b92

Please sign in to comment.