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-plugin-wikify

v1.0.0

Published

GitBook plugin that makes your book wiki-like

Downloads

6

Readme

Wiki-like GitBook books

This package comes in two parts: a command-line tool to:

  • Automatically populate SUMMARY.md with an index of all pages
  • Generate directory index pages

and a GitBook plugin to:

  • Insert breadcrumbs
  • Check for broken links
  • Check for orphaned pages

Usage

Add "wikify" to the list of plugins in your book.json:

{
    "plugins": ["wikify"],
    "pluginsConfig": {
        "wikify": {
            "lintOutput": "path/to/output.xml"
        }
    }
}

Then run gitbook install.

Building your book now requires two steps:

node_modules/.bin/gitbook-autoindex
gitbook build

You may want to add files that are automatically generated by the autoindexer to .gitignore; in which case, they should be un-ignored in .bookignore so that they're properly included in the book:

$ cat .gitignore
_index.md
SUMMARY.md

$ cat .bookignore
!_index.md
!SUMMARY.md

Directory Index

The automatically generated index page is pretty bare-bones. If you want to use your own index, create an index.md file under the directory and it will be copied as-is.

Any link to a directory will be rewritten as a link to <dir>/_index.md.

Breadcrumbs

Breadcrumbs will have this HTML structure:

<nav class="wikify-breadcrumbs">
  <a class="wikify-breadcrumbs-link" href="../">Top</a>
  <span class="wikify-breadcrumbs-sep"> &gt; </span>
  <a class="wikify-breadcrumbs-link" href="_index.html">network</a>
  <span class="wikify-breadcrumbs-sep"> &gt; </span>
  <span class="wikify-breadcrumbs-static">router.md</span>
</nav>

Broken Links

Broken links are reported in GitBook build's console output in TAP format.

ok links ok in copy.md
ok links ok in retro.md
not ok link broken in README.md -> errors.md, benchmark.org, tooling.md

Orphaned Pages

Orphaned pages are reported in the lintOutput file, if specified, in jslint's XML format.

<?xml version="1.0" encoding="utf-8"?>
<jslint>
  <file name="learning.md">
    <issue line="1" char="1" evidence="learning.md" reason="weak discoverability: no page links to this page" />
  </file>
</jslint>