Skip to content

Latest commit

 

History

History
86 lines (50 loc) · 2.14 KB

readme.md

File metadata and controls

86 lines (50 loc) · 2.14 KB
Raw

hexagon

Hexagon

Code Climate npm npm npm npm XO code style

A package manager for Hexo.

Prerequisites

  • NodeJS
  • Git

Getting Started

Install:

$ npm install -g hexagon-cli

You can use it by running:

$ hexagon --help

# or

$ hexa --help # For the minimalists out there

Usage

usage_gif

For Hexagon to work properly, make sure you are in your project's root directory.

To install a plugin:

  • Pass the -p or --plugin flag or just plugin
  • Pass the npm package[s] name
$ hexagon --plugin hexo-generator-github
$ hexagon -p hexo-generator-github
$ hexagon plugin hexo-generator-github

To install a theme:

  • Pass the -t or --theme flag or just theme
  • Pass the Github abbreviation, e.g adamsiwiec/hexagon-theme
$ hexagon --theme adamsiwiec/hexagon-theme
$ hexagon -t adamsiwiec/hexagon-theme
$ hexagon theme adamsiwiec/hexagon-theme

To list all themes and plugins

$ hexagon list

For more commands:

$ hexagon --help

Contributing

Please submit Issues or Pull Requests to continue the development of Hexagon

Versioning

We use SemVer for versioning. For the versions available, see the NPM site or the releases.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License