Code Monkey home page Code Monkey logo

typedoc-default-themes-dark's Introduction

Default themes for TypeDoc with addition of prefers-color-scheme: dark colors

Uses default themes from https://github.com/TypeStrong/typedoc-default-themes with the addition of dark colors for the default theme.

@media (prefers-color-scheme: dark)

See: src/default/assets/css/_theme.scss

Note: Made for Typedoc < 0.22, as the templating changes in 0.22 to JSX. No longer supported. Typedoc seems to support some level of light/dark themes in the defaults.

Install

npm add --dev typedoc-default-themes-dark

screen2

screen3-light

Usage

typedoc ./file.ts --theme ./node_modules/typedoc-default-themes-dark/bin/default/

or add the theme to your tsconfig.json

{
  "typedocOptions": {
    "theme": "node_modules/typedoc-default-themes-dark/bin/default/"
  }
}

Build

To make a build:

npm run build

This puts the theme you want to use in bin/default/.

This module contains the default themes of TypeDoc. Visit https://typedoc.org/ to learn more about TypeDoc.

Contributing

Contributions are welcome and appreciated. You can find TypeDoc on GitHub, feel free to start an issue or create a pull requests:
https://github.com/TypeStrong/typedoc

To use a local build of this project, run the npm pack command in this directory. Then in the project where you want to use your local build run npm install ../path/to/typedoc-default-themes-VERSION.tgz

License

Copyright (c) 2015 Sebastian Lenz.
Copyright (c) 2016-2020 TypeDoc Contributors.
Licensed under the Apache License 2.0.

typedoc-default-themes-dark's People

Contributors

aciccarello avatar alalonde avatar bennyhinrichs avatar blakeembrey avatar dependabot[bot] avatar gdelmas avatar gerrit0 avatar greenkeeperio-bot avatar h4rryp0tt3r avatar iliasidorovint avatar jonchardy avatar kamranayub avatar katanacrimson avatar kayahr avatar krisztianb avatar maximkott avatar nicknisi avatar pascalberger avatar rdepena avatar rklfss avatar rockerboo avatar sebastian-lenz avatar sgrishchenko avatar simonihmig avatar socsieng avatar thegecko avatar thislooksfun avatar tobiaszcudnik avatar wojpawlik avatar yunyoujun avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

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.