Options - sidvishnoi/jekyll_helper GitHub Wiki

-h, --help

shows help message and exits

---

-v, --verbose

verbose additional messages

---

-c [CATEGORY [CATEGORY ...]], --category [CATEGORY [CATEGORY ...]]

Build posts and pages under given category.

In sample project, lets say we build dogs category

-c dogs or -c content/dogs or --category dogs are equivalent. The index.html will be generated as the index for dogs.

-c dogs cats will make both dogs and cats category, sequentially.

-c animals, (comma in end) will build both cats and dogs in animals category. The index.html will be generated for animals (not for dogs or cats)

-c or --category (if you don't pass any additional arguments), you'll be prompted to get as many categories you want. The prompts feature auto-complete. For example, >> an[TAB] == animals

---

--home

builds home page.

Currently in v1, it takes all posts from content/ and builds using them (using --limit_posts 8 default).

TODO: build using N latest posts from each (or given) category (helpful for magazine like websites)

---

-n, --new

Creates new post and adds some front-matter to generated post. Opens up editor (set in helper.py > main() > settings {})

Prompts:

Post category: categories from content/ (auto-complete)
Layouts: layouts from source/_layouts/ (auto-complete)
Title: post title
(optional) author, permalink

You can add your own front matter details by editing helper.py (will add an easier API in next versions)

---

-e, --edit

Edit a post. Prompts : Edit post by title or file name (with auto-complete)

---

-a, --assets

Build static assets (files in source/assets/ folder)

---

-p, --pages

Build static pages (from content/pages/)

---

-s, --sitemap

---

Build website sitemap (using all .html from public folder)

-f, --fresh

---

Start a fresh build, clears public folder.

-l, --local

---

Show public folder on local server (localhost:8000). Press [Enter] to kill server. (else find PID and kill)

-g {save,revert}, --git {save,revert}

                backup and restore (TODO)

---

--comments

Manage comments and replies. Gets comments in a Google Sheet, moderate in sheet or locally in browser (after pre-moderation) and adds files in source/data/comments/ that adds comments to a post during build

See Comments for set up and usage.

---

-d {git_p,s3,gae,git} [{git_p,s3,gae,git} ...], --deploy {git_p,s3,gae,git} [{git_p,s3,gae,git} ...]

Deploy public directory. Edit deployment_methods in helper.py > main() > deployment_methods`.