Coder Social home page Coder Social logo

sleelin / classy-template Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 604 KB

Improvements on the default JSDoc template for modern ESM-style source code.

Home Page: https://www.sleelin.io/classy-template/

JavaScript 78.69% CSS 21.31%
documentation jsdoc jsdoc-template

classy-template's People

Contributors

sleelin avatar

Stargazers

 avatar

Watchers

 avatar

classy-template's Issues

Table of Contents Type Definitions link broken

The link added to the table of contents for the Type Definitions section currently points to the element with ID "type%20definitions". The ID of the type definitions section is "typedefs".

Hosted git logo missing when HEAD is detached

Observed when a specific tag or commit is checked out and documentation generated.
This appears to be caused by assuming HEAD will always be formatted as ref: refs/heads/<some-branch>, and looking for the commit reference at said location in the .git directory. When this happens, all details of the package's repository are ignored.

The HEAD may very well itself be a commit reference (e.g. when a specific tag or commit are checked out). When this happens, and the HEAD file is opened, if no branch ref is found, it should be assumed that it instead already points directly to a specific commit.

Footer causing overflow on small viewports

When pages are viewed on small viewports (e.g. a mobile phone), and the documentation generation date is also included in the footer, there is no opportunity for the text to wrap correctly. Due to the scrolling overflow set on the footer's parent main element, the page is then able to be scrolled off-screen. This is particularly noticeable when automatically scrolling to a specific location in a source file page.

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.