@blazed-space/blz-typedoc-theme
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

blz-typedoc-theme

"Screenshot" Screenshot

Typedoc theme made by Blazed Labs LLC (support v0.24).

Built by Blazed Labs "Built by Blazed Labs"

Using This Theme

Either clone this repo and copy the /example directory, or:

  1. Install typedoc & blz-typedoc-theme
npm install typedoc @blazed-space/blz-typedoc-theme
  1. Create a typedoc config (typedoc.json)
{
  "$schema": "https://typedoc.org/schema.json",
  "includeVersion": true,
  "plugin": ["@blazed-space/blz-typedoc-theme"],
  "theme": "my-theme",
  "entryPoints": ["./src/index.ts"],
  "out": "./docs"
}
  1. Be sure to create a /media folder, and at minimum add a favicon.ico, manifest.json, and /styles/global.css.
  2. To build documentation, add the following scripts to your package.json:
{
    "scripts": {
        "docs:build": "npx typedoc",
        "docs:serve": "cd docs && npx static-server"
    }
}
  1. You can now build docs using the command:
npm run docs:build
  1. Once built, you can open the .html files directly in the browser (not reccommended) or you can run a local static server with the following command:
npm run docs:serve

Local Development

  1. To develop this theme locally, first clone the GitHub repo
git clone https://github.com/blazed-space/blz-typedoc-theme
  1. Next, install dependencies with NPM:
npm install
  1. Now you can build the library:
npm run lib:build
  1. And build the example site:
npm run example:build
  1. To serve the example site locally,
npm run example:serve

Readme

Keywords

Package Sidebar

Install

npm i @blazed-space/blz-typedoc-theme

Weekly Downloads

4

Version

0.0.2

License

MIT

Unpacked Size

31.9 kB

Total Files

28

Last publish

Collaborators

  • blazed-labs