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

pug-start

v1.0.2

Published

CLI tool for Pug templates.

Downloads

6

Vulnerabilities

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

Links

Git

Maintainers

maksymblankmaksymblank

Keywords

puglayoutdefaultbaseclitemplate

Readme

pug-start

CLI tool for Pug templates.

Installing

npm

To install pug-start using npm, simply run:

$ npm i --save -g pug-start

Using

All you have to do is to install package globally and run pg-cli in Command Line.

$ pg-cli <pug-directory>

Template directory must be specified when compiling a pg-cli.

If the directory is empty, index.pug, footer.pug, and header.pug will be compiled automatically.

CLI Questions

After running pg-cli in Command Line you will be asked questions about your template.

  • Enter your title: - <title>YOUR TITLE</title>
  • Enter your keywords (delimeter: ','): - <meta name="keywords" content="YOUR_KEYWORDS" />
  • Enter your description: - <meta name="description" content="YOUR_DESCRIPTION" />
  • Do you want to set 'follow' in robots.txt? - <meta name="robots" content="index, follow" />
  • Do you want to set 'index' in robots.txt? - <meta name="robots" content="index, follow" />
  • Enter your GoogleAnalyticsId if you want to add it (leave empty if not): - If you want to add google analytics script to your template, enter your googleAnalyticsId
  • Do you want to include 'footer' section? - include './sections/footer.pug' to your template.
  • Do you want to include 'header' section? - include './sections/header.pug' to your template.
  • Do you want to add 'itemscope' and 'appleMobileWebAppCapable' parameters? - <html itemscope itemtype="http://schema.org/Website">

CLI cdnjs

After the above questions, you will be asked which CDNs you want to add to your template.

Only if you chose 'cdn' in 'Please select sections you want to include in your template'

Example:

Flags

-r // If index.pug exists, but it was not compiled with pg-cli, this flag will overwrite it and wrap it with the pg-cli layout.
Command Line:
$ pg-cli ./views -r

Content of the index.pug will be saved.

Example:

index.pug before:

section.jumbotron
    .container
        h1.jumbotron-heading Album example
        p.lead.text-muted 
            | Something short and leading about the collection..
        p
            a(href="#").btn.btn-primary.my-2 Main call to action

The code above was taken from getbootstrap.com

index.pug after:

extends _base/layout

//- Include all files
//- All configurations for the template
block config
    include _base/config

block main
    section.jumbotron
        .container
            h1.jumbotron-heading Album example
            p.lead.text-muted 
                | Something short and leading about the collection..
            p
                a(href="#").btn.btn-primary.my-2 Main call to action

Contribute

Please file an issue if you think something could be improved. Please submit Pull Requests when ever possible.