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

@puzle/one_pager

v0.5.0

Published

webpage compilation

Downloads

1

Readme


author: Cedric Chariere Fiedler

One Pager

With One Pager, transforming your data into a nice and beautiful html file has never be so easy!

Because a Readme.md file stays stern and colorless, transform it into a beautiful landing-page with a single input into your CI process!

You want to agregate all your generated content (tests reports and coverages, documentation, technical and functional design documents...) in a nice portal? Let's try our amazing tool!

Do you have funnier use cases to sublimate your data?

To infinity and beyond with One Pager!

Using as binary

One Pager can be used as binary. We are working on a server integration.

Install Globally

One-Pager is a npm package and can be installed by typing the following line:

npm install -g @puzle/one-pager
one-pager .

(Alternative) Install locally

You can install our tool as a local dependency and use it with npx

npm install @puzle/one-pager
npx one-pager .

Display the help

You can display the help and list each options by typing:

one-page -h

The Configuration file

By default, the One-Pager binary searchs on the current directory a configuration file named one-pager.json.

You can override the path with the option -c

one-pager -c ./config/one-pager.portal.json

The configuration file format

The configuration file must follow this format:

{
    "template": "http://path-to-my-template.com/index.html",
    "destination": "./dist/result.html",
    "data": [
        {
            "url": "readme.md"
        }, {
            "url": "./metadata.yml"
        }, {
            "url": "./package.json"
        }
    ]
}

template:
The location of the template used during the compilation step. See the relative section to know how to write your own template.

destination:
The destination of the generated file. You have to give the full name, including the filename.

data:
Several data can be used to hydrate the template file. Their order is important because it defines the data priority. If two files have the same keys, only the ones placed at the lesser position will be keeped. You can integrate local and remote files. The remote files must be accessible by the http or https protocols.

Our Roadmap

  • Testing
    • 100% code coverage for the Unit Testing
    • e2e testing
  • Documentation
    • Auto Generation
    • Deploy the doc as Gitlab Pages content
  • Add a HTML pages based on One Pager
  • Features
    • one-pager init to generate an empty config file with the default fields
    • Support of a static folder to copy into the final destination
    • Rework the destination option: use only a folder and specify the final name by a specific configuration option

License

BSD