Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

esdoc-custom-theme

sinnerschrader268MIT1.4.2

A customizable theme for esdoc

esdoc, theme, jsdoc, esdoc-template, custom-theme, documentation-theme

readme

🎓 Esdoc custom theme

A customizable theme for esdoc (using modern browser features)

npm Standard Version GitHub license GitHub issues

Travis branch bitHound bitHound

yarn Commitizen friendly

yarn add esdoc-custom-theme

Documentation

Documentation

Current features

  • Search
  • responsive
  • developer customizable
  • reader customizable
  • persistent settings (via localStorage)
    • repos in the same space will share the storage 👻🎓
  • light and dark mode
  • 49 colorschemes to choose from
  • perfect syntax highlighting for jsx (it's not common)

Next features

  • define default colorscheme per css (custom-properties/css-variable)
  • load custom font via google-fonts (reader customizable)

Screenshots

Dark mode

dark mode theme

Light mode

light mode theme light mode theme search

Responsive

responsive iphone responsive iphone-menu

Colorschemes

theme cobalt theme dracula

© Copyright 2018 Gregor Adams
Proudly powered by Sinnerschrader(Github)

changelog

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.4.2 (2018-03-05)

1.4.1 (2018-02-28)

Bug Fixes

  • sidebar-left: opened links caused empty sidebar (1907e97)

1.4.0 (2018-02-28)

Features

  • sidebar-left: better manula links (opened/closed) (db849aa)

1.3.5 (2018-02-27)

Bug Fixes

  • better monospace font for box drawing on OS X (601fa19)

1.3.4 (2018-02-22)

Bug Fixes

  • syntax-highlighter: better file name handling with regex (119b327)

1.3.3 (2018-02-15)

Bug Fixes

  • searchbar: search matches did work with uppercase characters (9ed80ed), closes #5
  • sidebar: remove console.log (35be343)

1.3.2 (2018-02-15)

Bug Fixes

  • sidebar: handle non hash/appendix links (ac42e9f)

1.3.1 (2018-02-15)

Bug Fixes

  • sidebar: correctly handle "~" links in URL (d0875e4)

1.3.0 (2018-02-13)

Bug Fixes

  • hash-targets: handle dirty IDs (33170d8)
  • list: don't reset paddings and margins (03c282e)

Features

  • active-links: acgive links and collapsible sections (1f37115)
  • global-elements: helper for closest parent (44b7522)
  • mode-selector: added variables for new features (534508c)
  • searchbar: highlight matches in results (5e9ded5)

1.2.0 (2018-02-13)

Bug Fixes

  • kind: minor style glitch (bb0f7ad)

Features

  • integrate normalize (7dcd962)
  • style details & active-targets (70618a3)
  • fonts: added a font for dyslexia (c9596ee)

1.1.0 (2018-02-12)

Bug Fixes

  • menu-switch: hide on large viewports (9ace3d1), closes #1
  • syntax-highlighter: handle hashParsing for link-targets (5042eb4), closes #3

Features

  • sidebar: toggle sidebars on body click (3290a9c), closes #4

1.0.1 (2018-02-12)

1.0.0 (2018-02-12)

Bug Fixes

  • kind: add styles for kind-icons (773f13d)

1.0.0-rc1.1 (2018-02-12)

Bug Fixes

  • codemirror: make highlighted and default pre scrollable (8618585)
  • kind: add missing kinds (de449d3)
  • syntax-highlighter: add falback and fix matching (4c67d40)
  • syntax-highlighter: add missing import (ad8c8ee)

Features

  • base: activate hash-targets (5b1e019)

1.0.0-rc1.0 (2018-02-12)

Bug Fixes

  • settings-switch: correct classname (c7369ef)
  • sidebar: fix injected classnames (694c453)
  • sidebar: fix kind width (d821106)
  • sidebar: parse url correctly (cf75332)
  • syntax-highlighter: activate line number (50c633e)
  • syntax-highlighter: add css modes (c112551)
  • syntax-highlighter: better mode handling (9955d82)

Features

  • initial version (b5d6086)
  • colorscheme-selector: allow setting a colorscheme (6161148)
  • layout: responsive layout (7708cf4)
  • layout: responsive tables (40e3e52)