Giter VIP home page Giter VIP logo

sinnerschrader / esdoc-custom-theme Goto Github PK

View Code? Open in Web Editor NEW
17.0 7.0 4.0 6.15 MB

๐ŸŽ“ A custom and configurable theme for esdoc (using modern browser features)

Home Page: https://sinnerschrader.github.io/esdoc-custom-theme/

License: MIT License

CSS 31.86% JavaScript 45.78% HTML 22.35%
esdoc theme jsdoc esdoc-template custom-theme documentation-theme reponsive css-variables css-grid-layout

esdoc-custom-theme's Introduction

๐ŸŽ“ 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

Search

light mode theme search

Responsive

responsive iphone

responsive iphone-menu

Colorschemes

theme cobalt

theme dracula

ยฉ Copyright 2018 Gregor Adams
Proudly powered by Sinnerschrader(Github)

esdoc-custom-theme's People

Contributors

pixelass avatar

Stargazers

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

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

esdoc-custom-theme's Issues

Hide menu icon on larger viewports

Issue description

The menu icon is not needed on large screens.

Steps to reproduce

Open the documentation on a large viewport.
Clicking the icon does not toggle the sidebar.

Versions

  1. esdoc-custom-theme: 1.0.0

Search matches are shifted

Issue description

The search matches are highlighted in a different color. It seems like there is an issue if the match is in the beginning of the line. The matches are then shifted by 1 and the remaining one is added to the end of the line.

Steps to reproduce

This might be hard. I think it needs two matches in one line of which one is in the beginning of the line.
See "Master" in the image is not highlighted but the line ends with "mas"

screen shot 2018-02-14 at 01 01 44

Versions

  • esdoc-custom-theme: 1.3.0

errorLines causes page to go blank

Issue description

When clicking on a link in "sources.html" that has coverage data the resulting hash in the url causes an issue

Steps to reproduce

Open a page with index.js.html#errorLines=1,19,404 at the end

Example: file:///Users/greada/Documents/workspace/private/gaffney/docs/api/file/@gaffney/rise-set/src/index.js.html#errorLines=1,19,404

Log

bundle.js:formatted:82 Uncaught DOMException: Failed to execute 'querySelector' on 'Document': '#errorLines=1,19,404' is not a valid selector.
    at t.$ (file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:1420)
    at a (file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:219771)
    at Object.<anonymous> (file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:219813)
    at r (file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:385)
    at Object.<anonymous> (file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:219076)
    at r (file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:385)
    at file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:733
    at file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:743
    at file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:158
    at file:///Users/greada/Documents/workspace/private/gaffney/docs/api/script/bundle.js:1:223
t.$ @ bundle.js:formatted:82
a @ bundle.js:formatted:9825
(anonymous) @ bundle.js:formatted:9829
r @ bundle.js:formatted:22
(anonymous) @ bundle.js:formatted:9764
r @ bundle.js:formatted:22
(anonymous) @ bundle.js:formatted:53
(anonymous) @ bundle.js:formatted:54
(anonymous) @ bundle.js:formatted:7
(anonymous) @ bundle.js:formatted:11

Versions

esdoc-custom-theme: 1.0.1

Cross-site Scripting (XSS) via Data URIs [SEVERITY: HIGH]

Issue description

There is a security issue in a sub-dependency (dev Dependency) "marked"

Steps to reproduce

https://www.bithound.io/github/sinnerschrader/esdoc-custom-theme/master/dependencies/npm/esdoc-publish-html-plugin#security-advisories

Discovered in a nested dependency:[email protected]@0.3.6

https://snyk.io/vuln/npm:marked:20170112?utm_source=bithound

Cross-site Scripting (XSS) via Data URIs

Affecting marked package, versions <0.3.7

Versions

  1. esdoc-custom-theme: 1.0.0

Related Issues

esdoc/esdoc-plugins#50

close sidebar after navigation

Issue description

On small viewports the menu stays persistent after clicking a link

Steps to reproduce

  • look at the mobile/responsive version
  • click a link
  • the menu stays

Versions

  1. esdoc-custom-theme: 1.0.1

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.