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

transcription

v0.2.1

Published

Documentation generator for ES6.

Downloads

6

Vulnerabilities

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

Links

Git

Maintainers

affirmixaffirmix

Keywords

transcriptiondocumentationecmascript262ecmascript6es6

Readme

Build Status Coverage Status Dependency Status devDependency Status Gitter

What is Transcription?

Transcription is an ECMAScript 6 (ES6) documentation generator designed to provide JSON, Markdown, and template driven HTML output.

What can I expect from Transcription as development continues?

  1. Mutliple output formats. Flexible options should provided as each project and enviorment is unique. Transcription will out JSON structures (See Dox), Markdown (See Markdox), and template driven HTML output (See JSDoc).

  2. Dynamically linked projects and classes. One feature missing from many JavaScript documentation generators in linking to projects and classes outside of the scope of one single file. This is a feature that Transcription will aim to provide.

  3. Verify AST structures against JSDoc params. Becuase we have a proper AST object to compare with JSDoc doclets, an analysis will be peformed to verfiy that your comments matches the elements they are describing. This will developers track down any comments that become out of date, and inconsistencies that develop.

  4. Gulp npm module. After basic functionality has been implemented and tested, Transcription should be easy to integrate into your build system.

How can I use Transcription?

You can see Transcription in action on your own system by following these steps: (Dependant on Git and Node.js)

  1. npm install transcription
  2. One of the following commands: (For JSON, Markdown, and HTML respectively)
  • transcription --help
  • transcription -f html -i ./input -o ./output
  • transcription -f html -o ./output.html < ./input/controller.js
  • transcription -f html -o < ./input/controller.js > ./output/controller.html
  • transcription -f html -i ./input.html > ./output/controller.js