Skip to content

Baymax104/jekyll-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jekyll CLI

Jekyll Blog CLI Tool.

Usage:

$ blog [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • build: Build jekyll site.
  • config: Configuration Subcommands.
  • deploy: Deploy the site with the...
  • draft: Create a draft.
  • info: Show info about post or draft.
  • init: Initialize the application interactively.
  • list: List all posts and drafts or find items by...
  • open: Open post or draft in editor.
  • post: Create a post.
  • publish: Publish a draft.
  • remove: Remove a post or draft.
  • rename: Rename a post or draft.
  • serve: Start blog server locally through jekyll.
  • unpublish: Unpublish a post.

blog build

Build jekyll site.

Usage:

$ blog build [OPTIONS]

Options:

  • --draft / --no-draft: Build including drafts. [default: no-draft]
  • --help: Show this message and exit.

blog config

Configuration Subcommands.

Usage:

$ blog config [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List all configurations.
  • reset: Reset default configuration.
  • set: Set a configuration.

blog config list

List all configurations.

Usage:

$ blog config list [OPTIONS]

Options:

  • --help: Show this message and exit.

blog config reset

Reset default configuration.

Usage:

$ blog config reset [OPTIONS]

Options:

  • --help: Show this message and exit.

blog config set

Set a configuration.

Usage:

$ blog config set [OPTIONS] KEY VALUE

Arguments:

  • KEY: Configuration key using dot-notation. [required]
  • VALUE: Configuration value. [required]

Options:

  • --help: Show this message and exit.

blog deploy

Deploy the site with the '/jekyll-deploy.yml.'

Usage:

$ blog deploy [OPTIONS]

Options:

  • --help: Show this message and exit.

blog draft

Create a draft.

Usage:

$ blog draft [OPTIONS] NAME

Arguments:

  • NAME: Name of draft item. [required]

Options:

  • -t, --title TEXT: Title of draft.
  • -c, --class TEXT: Categories of draft.
  • -g, --tag TEXT: Tags of draft.
  • -e, --editor TEXT: Open draft in given editor.
  • -o, --open: Open draft automatically.
  • --help: Show this message and exit.

blog info

Show info about post or draft.

Usage:

$ blog info [OPTIONS] NAME

Arguments:

  • NAME: Name of post or draft. [required]

Options:

  • --help: Show this message and exit.

blog init

Initialize the application interactively.

Usage:

$ blog init [OPTIONS]

Options:

  • --help: Show this message and exit.

blog list

List all posts and drafts or find items by name.

Usage:

$ blog list [OPTIONS] [NAME]

Arguments:

  • [NAME]: Name of post or draft.

Options:

  • -d, --draft: List only all drafts.
  • -p, --post: List only all posts.
  • --help: Show this message and exit.

blog open

Open post or draft in editor.

Usage:

$ blog open [OPTIONS] NAME

Arguments:

  • NAME: Name of post or draft. [required]

Options:

  • -e, --editor TEXT: Open item in given editor
  • --help: Show this message and exit.

blog post

Create a post.

Usage:

$ blog post [OPTIONS] NAME

Arguments:

  • NAME: Name of post item. [required]

Options:

  • -t, --title TEXT: Title of post.
  • -c, --class TEXT: Categories of post.
  • -g, --tag TEXT: Tags of post.
  • -e, --editor TEXT: Open post in given editor.
  • -o, --open: Open post automatically.
  • --help: Show this message and exit.

blog publish

Publish a draft.

Usage:

$ blog publish [OPTIONS] NAME

Arguments:

  • NAME: Name of draft. [required]

Options:

  • --help: Show this message and exit.

blog remove

Remove a post or draft.

Usage:

$ blog remove [OPTIONS] NAME

Arguments:

  • NAME: Name of post or draft. [required]

Options:

  • --help: Show this message and exit.

blog rename

Rename a post or draft.

Usage:

$ blog rename [OPTIONS] NAME NEW_NAME

Arguments:

  • NAME: Name of post or draft. [required]
  • NEW_NAME: New name. [required]

Options:

  • --help: Show this message and exit.

blog serve

Start blog server locally through jekyll.

Usage:

$ blog serve [OPTIONS]

Options:

  • --draft / --no-draft: Start blog server with drafts. [default: no-draft]
  • --port INTEGER: Listen on the given port. [default: 4000]
  • --help: Show this message and exit.

blog unpublish

Unpublish a post.

Usage:

$ blog unpublish [OPTIONS] NAME

Arguments:

  • NAME: Name of post. [required]

Options:

  • --help: Show this message and exit.

Packages

No packages published

Languages