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

update-docs

v1.0.0

Published

Automatically keep your documentation updated and tested

Downloads

3

Readme

update-docs

update-docs allows you to use test cases to populate and update your documentation examples.

With update-docs, you can ensure that:

  • Your code continues to support your documentation examples.
  • The output of your documentation examples remains up-to-date.

Install

npm install -D update-docs

How to Use

1. Label code blocks in your documentation

<!---My Code⠀Block-->

```typescript

```

(Note the three -s)

2. Set up the UpdateDocs class

import { UpdateDocs } from 'update-docs'

const docs = new UpdateDocs({
    documentationGlobs: ['**/*.md'],
    testGlobs: ['test/**.test.ts'],
    modifyIndent: indent => indent.replace(/\t/g, '    ')
})

beforeAll(() => {
    docs.updateExamples()
})

3. Write a test case

test('addition', () => {
    // start docs My Code Block
    const sum = 2 + 2
    sum // {{sum}}
    // end docs My Code Block
    expect(sum).toBe(4)
    docs.replaceToken('My Code Block', '{{' + 'sum' + '}}', sum)
})

My Code Block

const sum = 2 + 2
sum // 4

That's it!

Now, when your run your test, UpdateDocs will update the code samples in your documentation, run the tests, and replace any tokens with their results.

See the UpdateDocs class for more API documentation.

This README is generated using update-docs! See README.test.ts for that implementation.

(P.S. You can repeat the same code block name in multiple files to keep them in sync.)