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

gitbook-comment

v2.0.1

Published

Generate Markdown file from comments in source code

Downloads

4

Readme

Markdown Generator based on comment (Ideal for Gitbook)

js-standard-style

What does it do?

It generate markdown for any comment line starting with /// (there is a space at the end of it).

/// ### Method Name
/// This is my awesome method.
function Sum(a, b) {
  /// This will convert to markdown
  // This is a normal comment
  return a + b
}
/* Another normal comment */

Above code will become this:

Method Name

This is my awesome method.

function Sum(a, b) {

This will convert to markdown

  // This is a normal comment
  return a + b
}
/* Another normal comment */

Instruction

  1. Install the npm using npm install --save gitbook-comment
  2. Use gitbook-comment --help to read the command line instructions
  3. Edit your package.json with
  "scripts": {
    "doc-generate": "gitbook-comment generate -p ./",
    "doc-clean-up": "gitbook-comment clean-up -p ./",
    "doc-publish": "gitbook-comment publish -p ./"
  }
  1. Make suer you have docs branch created locally on your machine by git branch docs
  2. Make sure you have your code committed on your working branch
  3. Run npm run doc-generate on your working branch:
    • This will switch branch automatically to docs
    • Create documents next to source files
    • Push them to github
    • Switch back to working branch

Note If you do not commit your work in working branch, it may get lost in switching the branches.

note: This generator is creating the .md files in same folder next to the original files.

Alternatively you can generate or clean up docs in any branch

# Generate doc in current branch
npm run doc-generate

# Check help for a command
npm run doc-generate -- -h

# Get full documentation
./node_modules/gitbook-comment/bin/gitbook-comment -h

# Use more more options on a command
npm run doc-generate -- -p ./src -i bin -e js,css,scss

# Clean up generated docs
npm run doc-comment clean-up

If you generate doc manually, make sure they are uploaded to docs or any other none development branch and use gitbook.com integration to view them.

  • You can learn more on how it works here
  • Demo project is located at https://github.com/pixelsandcode/gitbook-comment-demo