Package Exports

@devlander/typedoc-theme
@devlander/typedoc-theme/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@devlander/typedoc-theme) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@devlander/typedoc-theme

Description

This package provides a custom theme for generating documentation using TypeDoc.

Installation

Ensure you have Node.js (version >= 14) and npm (or Yarn) installed.

npm

npm install @devlander/typedoc-theme --save-dev

Yarn

yarn add @devlander/typedoc-theme --dev

Usage

To use @devlander/typedoc-theme as your theme in a TypeDoc project, follow these steps:

Configure TypeDoc

Ensure your TypeDoc configuration (typedoc.json) specifies @devlander/typedoc-theme as the theme:
```
{
  "theme": "@devlander/typedoc-theme"
  // Add other TypeDoc options as needed
}
```
Generate Documentation

Run TypeDoc to generate documentation using the configured theme:
```
npx typedoc --theme @devlander/typedoc-theme
```
If you have a script defined in package.json:
```
npm run docs
```
Or with Yarn:
```
yarn docs
```
View Documentation

Once generated, your documentation will be available in the specified output directory (default is docs/).

Configuration

Options

theme (required): Specify "@devlander/typedoc-theme" as the theme in your TypeDoc configuration file (typedoc.json).

Example

Here's a basic example of a typedoc.json configuration using @devlander/typedoc-theme:

{
  "theme": "@devlander/typedoc-theme",
  "out": "docs/",
  "exclude": ["node_modules/**/*"]
}

License

This package is licensed under the MIT License.