Code Monkey home page Code Monkey logo

typedoc-just-the-docs-theme's Introduction

typedoc-just-the-docs-theme

This theme is made to work with the jekyll theme just-the-docs. It also requires typedoc-plugin-markdown to work.

Supports TypeDoc 0.22.x

What is does?

Note this theme was not extensively tested and was made to cover a single use case.
  • Generates github well organized path directory
  • Append on each markdown page a YML front matter with specifies from just-the-docs.

Requirements

Usage

npm install typedoc-just-the-docs-theme --save-dev

On typedoc.json file.

{
  "theme": "just-the-docs"
}

Road map

  • Add tests

typedoc-just-the-docs-theme's People

Contributors

luizstacio avatar

Stargazers

Ralph Schuler avatar jojo avatar Stuart Morris avatar olli avatar

Watchers

Anderson Arboleya avatar César D. Rodas avatar Daniel Frederico Lins Leite avatar  avatar JC avatar Scott Williams avatar Brandon Kite avatar David Mihal avatar Rodrigo Araújo avatar Barnyard avatar Chad Nehemiah avatar  avatar Mitchell Turner avatar Elvis avatar Tomide Oladipo avatar Peter Smith avatar Nick Furfaro avatar Nedim Salkić avatar Green Baneling 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.