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

@ulu/vuepress-plugin-sassdoc

v2.0.0

Published

Creates pages for sassdoc groups in vuepress (as markdown). Works with Vuepress 2, see old releases (v1) for Vuepress 1 version. Supports all annotations, custom annotations, groups display name and description, and content blocks in content. Items organi

Downloads

2

Readme

Output with Watcher/Cleanup (Use with Caution!)

The script example below is deleting files, it's important to have the directory backed up incase you make any mistake with the paths/setup. Please use caution implementing this.

The example below watches for changes and rebuilds the directory the outputPages is building into. In the example below your would pass "--watch" to enable the watch and rebuild.

import fs from "fs-extra";
import path from "path";
import chokidar from "chokidar";
import { outputPages } from "@ulu/vuepress-plugin-sassdoc";
import options from "./sassdoc-options.js";

const isWatch = process.argv.includes("--watch");
const outputFolder = path.join(options.dist, options.pathBase);
const watchOptions = { ignoreInitial: true, cwd: options.dir };
let running = false;

async function output() {
  if (!running) {
    running = true;
    cleanOutputDir();
    await outputPages(options);
    running = false;
  }
}
function cleanOutputDir() {
  const dir = fs.readdirSync(outputFolder);
  dir.forEach(item => {
    const fullpath = path.join(outputFolder, item);
    // Delete if directory (was created by sassdoc plugin)
    if (fs.lstatSync(fullpath).isDirectory()) {
      fs.removeSync(fullpath);
    }
  });
}

// The creation of pages is async
(async () => {
  try {
    await output();
    if (isWatch) {
      chokidar
        .watch("**/*.scss", watchOptions)
        .on('all', output);
    }
  } catch (error) {
    console.log(error);
  }
})();