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

flimflam-docs-scaffold

v0.0.8

Published

scaffold for creating docs with flimflam

Downloads

8

Readme

#A flimflam component for easily generating a docs page.

###Example http://yutakahoulette.com/flimflam-docs-scaffold

###Usage

npm install flimflam-docs-scaffold

JS

const h = require('flimflam/h')
const times = require('ramda/src/times')
const identity = require('ramda/src/identity')
const reduce = require('ramda/src/reduce')
const flyd = require('flimflam/flyd')
const render = require('flimflam/render')
const scaffold = require('flimflam-docs-scaffold')

const init = () => ({ scaffold: scaffold.init() }) 

const lorem = "Lorem ipsum dolor sit amet, a cras mauris ut rhoncus vitae, nunc ullamco, eu scelerisque aliquam vivamus, eget vitae penatibus vivamus. Scelerisque velit felis suspendisse quam eu, mauris lacus lectus leo enim facilisis, etiam vel. Lacinia tincidunt nunc dolores. Nascetur turpis, a fusce imperdiet, urna integer ipsa laoreet, viverra dolor vel libero. Quam lacinia aliquam eu, mi eu nulla diam erat amet. Varius montes purus mauris nulla wisi, adipiscing ut. Duis justo mi cras nec voluptatibus, sunt gravida donec sed."

// returns an object like:
//  {
//    'section 1' : h('p', lorem)
//  , 'section 2' : h('p', lorem)
//  , etc...
//  }
const dictionary = reduce((a, b) => {
    a[`section ${b+=1}`] = h('p', lorem)
    return a
  }, {}, times(identity, 20))

const view = state => {
  return h('div', [
  , scaffold.view(state.scaffold, {
      dictionary$: flyd.stream(dictionary)
    , title: 'Demo'
    , header: h('h1.pb-5', 'Demo header')
    })
  ])
}

const container = document.getElementById('container')

render(view, init(), container)

CSS (build with postcss and postcss-import)

@import 'flimflam-docs-scaffold';

body { background: rgb(242, 242, 242)}

/* sets border color on current nav link */
.tabs--v li.is-selected { border-color: rgb(0, 255, 114)}