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

apidoc-plugin-specs

v1.0.3

Published

Use apidoc to generate functional specifications in project

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

samkersamker

Keywords

apidoc

Readme

apidoc-plugin-specs

Use apidocjs to edit functionnal specifications

install

npm i -D apidoc-plugin-specs

usage

same as apidoc but use specific template here

apidoc -t template -i example -o tmp

api

the directive @api is forced by apidoc we have to declare it, but nothing is saved

  • @apiSpec {type} {groupe} Title
    • type = "team || func"
    • groupe overwrite definition @api
    • title overwrite title and name from @api
  • @apiSpecVersion overwrite @apiVersion
  • @apiSpecTeam specify team éléments
  • @apiSpecFunc define a fonctional specification

example

  • Team
/**
 * @api {spec} / SPEC Team
 * @apiSpec {team} {groupTeam} titleTeam
 * @apiSpecVersion 1.0.0
 * @apiSpecTeam {service1} {role1} {2018-01-01} {---} Name1
 * @apiSpecTeam {service2} {role2} {2018-02-03} {2018-03-04} Name2
 */

define block with contributors

  • Functions
/**
 * @api {spec} / SPEC Func
 * @apiSpec {func} {groupFunc} titleFunc
 * @apiSpecVersion 1.0.0
 *
 * @apiSpecFunc {specid_01} {2018-01-01} 1ère fonctionnalité
 * specification détaillé
 * - sur plusieurs ligne
 * - qui précise ce qu'on veut
 *
 * @apiSpecFunc {specid_02} {2018-03-03} 2ème
 * specification détaillé blabla
 * - sur plusieurs ligne
 * - qui précise ce qu'on veut
 *
 */

define list of fonctional specifications