npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eledoc

v0.2.1

Published

A material dark theme for TypeDoc

Downloads

330

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

pirix-ghpirix-gh

Keywords

typescriptdocumentationgenerator

Readme

Table of Contents

📜 About

eledoc is a delightful dark theme for TypeDoc

Goals

  • Provide a nice user experience
  • Proper layout with visual cues
  • Fix problems from usual themes

🍩 Features

  • All the features from the default typedoc themes
  • Create sections with @[tag-name] in doc comments

🏁 Getting Started

Prerequisites

npm install typedoc --save-dev

Installation

npm install eledoc --save-dev

Hello World

With the command line

npx typedoc --out docs src --theme node_modules/eledoc/bin/default/

Or in your package.json

"scripts": {
  "build:docs": "typedoc --out docs src --theme node_modules/eledoc/bin/default/",
}

🧠 Good to Know ⤢

In this wiki, you'll find some extra resources for your learning & understanding.

It is incremental and it will be completed on demand, you can ask for this below.

Questions ⤢

Are you missing something? Participate to the open-wiki by posting your questions right here.

🎁 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. There are many ways to contribute to the project:

Community

Pull Requests

  1. Read the tutorial
  2. Fork the project
  3. Clone your fork
  4. Create a pr/feature branch
    git checkout -b pr/CoolFeature
  5. Commit your changes
    git commit -m 'Added this CoolFeature'
  6. Run the tests
  7. Commit your changes
    git push origin pr/CoolFeature
  8. Open a pull request

👏 Sponsoring issues

Sponsored issues have higher priority over non-critical issues.

You can either request a new feature or a bug fix then fund it.

The money will be transparently split with an issue's assignees.

🔮 What's next

  • Re-write with React

🙏 Acknowledgements

Many, many thanks to all the contributors

💟 Friendly Projects