pug-start
CLI tool for Pug templates.
Installing
npm
To install pug-start using npm, simply run:
$ npm i --save -g pug-startUsing
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:
? Please enter the name of the CDN you would like to add: jquery
⠙ Looking for package..
jquery has been successfully added to your cdn file.
? Please enter the name of the CDN you would like to add: animate
⠦ Looking for package..
Package name is incorrect. Please enter one of the names below or try another:
animate.css
animateplus
jquery-animateNumber
animatelo
animated-header
leaflet.AnimatedMarker
marker-animate-unobtrusive
just-animate
animateCSS
css3-animate-it
? Please enter the name of the CDN you would like to add: animate.css
⠚ Looking for package..
animate.css has been successfully added to your cdn file.
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 actionThe code above was taken from getbootstrap.com
index.pug after:
extends _base/layout //- Include all files//- All configurations for the templateblock 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 actionContribute
Please file an issue if you think something could be improved. Please submit Pull Requests when ever possible.