octopress / ink

A core component for building Gem based Jekyll themes.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CLI: ink info

imathis opened this issue · comments

Syntax:

octopress ink info [plugin_name] [options]

This would output information about Octopress ink and list all plugins and their versions.

For example octopress ink info would return:

Octopress Ink - v1.0.3
website: http://octopress.org/ink/
Plugins:
- octopress-pygments v1.5.1
- some-plugin v0.0.5

If a plugin name is passed, octopress ink some-plugin this will list the plugin name, version and website and then it would list out all of the assets used by the plugin. Here's an example.

awesome-plugin (theme) - v1.0.0
Site: https://github.com/some-guy/plugin-name
Layouts:
  - default.html
  - page.html
  - post.html (from: _plugins/theme/layouts/)
Files:
  - favicon.ico
  - robots.txt
Stylesheets:
  - site.scss (from: _plugins/theme/stylesheets/)

If you just wanted to know about one type of asset you could pass the asset type as a flag. For example:

octopress ink info steve --layouts --includes

Here would be the output.

Steve (plugin) - v1.5.2
Site: https://github.com/mrsteve/octopress-steve
Layouts:
  - default.html
  - page.html
  - post.html (from: _plugins/theme/layouts/)
Includes: none

This only works for installed plugins, right?

Each plugin can have its own PluginName.info method which can be used to access this stuff.