Giter Club home page Giter Club logo

typedoc-theme's Introduction

@mxssfd/typedoc-theme

截屏2023-04-11 17 56 04

截屏2023-04-11 17 55 25

截屏2023-04-11 17 56 49

截屏2023-04-11 17 57 06

Installation

npm install typedoc @mxssfd/typedoc-theme -D

Usage

use script command

typedoc --plugin @mxssfd/typedoc-theme --theme my-theme

or

use typedoc.json

{
  "$schema": "https://typedoc.org/schema.json",
  "plugin": ["@mxssfd/typedoc-theme"],
  "theme": "my-theme"
}

typedoc-theme's People

Contributors

amgelo563 avatar mengxinssfd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

typedoc-theme's Issues

Theme is not set for every page on Firefox

On Firefox 118.0.2 only the current page is put in dark mode if I change theme in settings of this page to "Dark". All other pages remains with theme "OS". And the theme for this page is saved and persists even restarting the browser.

The same thing does not happens on Chrome 118.0.5993.71 (Official Build) (64-bit). That is, all pages acquire the same theme.

I'm using typedoc 0.25.2 with "@mxssfd/typedoc-theme": "^1.1.3", on Windows 11 64-bits
Thanks for your help!
mario

Support typedoc v0.25.1

Hi @mengxinssfd,
we recently updated to typedoc v0.25.1 because we needed a new feature implemented there. However, npm complains that the range of the peer dep does not match. When using force it installs and builds successfully, however, all icons are gone:

Old Version (OK) New Version (Broken)

grafik

grafik

TypeError: context.iconsCache is not a function

Hey @mengxinssfd !

When I try to run typedoc with a theme I get an error

TypeDoc exiting with unexpected error:
TypeError: context.iconsCache is not a function
    at defaultLayout (/Users/johan/NoLoSay/NoLoApp/node_modules/@mxssfd/typedoc-theme/dist/templates/defaultLayout.js:51:21)
    at ThemeContext.defaultLayout (/Users/johan/NoLoSay/NoLoApp/node_modules/@mxssfd/typedoc-theme/dist/ThemeContext.js:7:22)
    at DefaultTheme.defaultLayoutTemplate (/Users/johan/NoLoSay/NoLoApp/node_modules/typedoc/dist/lib/output/themes/default/DefaultTheme.js:37:53)
    at MyTheme.render (/Users/johan/NoLoSay/NoLoApp/node_modules/typedoc/dist/lib/output/themes/default/DefaultTheme.js:168:37)
    at Renderer.renderDocument (/Users/johan/NoLoSay/NoLoApp/node_modules/typedoc/dist/lib/output/renderer.js:184:40)
    at /Users/johan/NoLoSay/NoLoApp/node_modules/typedoc/dist/lib/output/renderer.js:160:22
    at Array.forEach (<anonymous>)
    at Renderer.render (/Users/johan/NoLoSay/NoLoApp/node_modules/typedoc/dist/lib/output/renderer.js:158:25)
    at async Application.generateDocs (/Users/johan/NoLoSay/NoLoApp/node_modules/typedoc/dist/lib/application.js:309:9)
    at async run (/Users/johan/NoLoSay/NoLoApp/node_modules/typedoc/dist/lib/cli.js:110:13)

The command I use is typedoc --options ./typedoc.json

typedoc.json being

  "entryPoints": ["./src/**/*.tsx"],
  "out": "docs/documentation",
  "tsconfig": "tsconfig.json",
  "plugin": ["@mxssfd/typedoc-theme"],
  "theme": "my-theme",
  "name": "NoLoApp",
  "customCss": "docs/setup/assets/style.css",
  "includeVersion": true
}```

Do you have any Idea of why this happens ? Thanks a lot !

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.