typedoc-particles-theme v1.0.9

Neo theme for TypeDoc

This plugin contains a new theme for TypeDoc with tsParticles acting like an animated background.

Visit the tsParticles reference to view this theme.

Visit http://typedoc.org/ to learn more about TypeDoc.

Theme

Build the theme by running npm run build .

After you install the module, you can use this theme in a build by running:

typedoc --theme ./node_modules/typedoc-particles-theme/bin/particles

Typedoc options

This plugin adds additional options that can be placed in your typedoc.json file.

Links

You may want to specify additional links to appear in your header that don't point to reference documentation but related documentation for your platform.

"particles": {
  "groups": [
    {
      "title": "Documentation",
      "pages": [
        {
          "title": "My Page",
          "source": "./markdown/index.md"
        }
      ]
    }
  ],
  "enableSearch": false,
  "links": [
    {
      "label": "Official Website",
      "url": "https://particles.matteobruni.it"
    }, {
      "label": "Repository",
      "url": "https://github.com/matteobruni/tsparticles"
    }
  ]
}