Browse Source

update readme, license, etc.

pull/2/head
Jake Jarvis 2 years ago
parent
commit
9d5f8ac522
Signed by: jake GPG Key ID: 2B0C9CF251E69A39
  1. 4
      LICENSE.md
  2. 94
      README.md
  3. 11
      package.json

4
LICENSE → LICENSE.md

@ -1,6 +1,6 @@
The MIT License (MIT)
MIT License
Copyright (c) 2016 FennecLab
Copyright (c) 2020-present Jake Jarvis <jake@jarv.is>, (c) 2016 FennecLab.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

94
README.md

@ -1,14 +1,16 @@
# hugo-bin [![npm version](https://img.shields.io/npm/v/hugo-bin.svg)](https://www.npmjs.com/package/hugo-bin) [![Build Status](https://img.shields.io/travis/fenneclab/hugo-bin/master.svg)](https://travis-ci.org/fenneclab/hugo-bin) [![dependencies Status](https://img.shields.io/david/fenneclab/hugo-bin.svg)](https://david-dm.org/fenneclab/hugo-bin) [![devDependencies Status](https://img.shields.io/david/dev/fenneclab/hugo-bin.svg)](https://david-dm.org/fenneclab/hugo-bin?type=dev)
# hugo-node [![CI status](https://github.com/jakejarvis/hugo-node/workflows/Test/badge.svg)](.github/workflows) [![Hugo v0.63.2](https://img.shields.io/badge/Hugo-v0.63.2-orange)](https://github.com/gohugoio/hugo) [![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=jakejarvis/hugo-node)](https://github.com/jakejarvis/hugo-node/pulls?q=is%3Apr+label%3Adependencies)
> Binary wrapper for [Hugo](https://gohugo.io/)
> Plug-and-play binary wrapper for [Hugo](https://gohugo.io/), the awesomest static-site generator.
## Install
```sh
npm install hugo-bin --save-dev
npm install hugo-node --save-dev
# or...
yarn add hugo-node --dev
```
hugo-bin now supports the [Extended Hugo version](https://github.com/gohugoio/hugo/releases/tag/v0.43). See [Installation options](#installation-options) for more details.
`hugo-node` defaults to the [extended version](https://gohugo.io/getting-started/installing/#linux) of Hugo on [supported platforms](https://github.com/gohugoio/hugo/releases), and falls back to vanilla Hugo automatically if unsupported.
## Usage
@ -16,7 +18,7 @@ hugo-bin now supports the [Extended Hugo version](https://github.com/gohugoio/hu
```js
const { execFile } = require('child_process');
const hugo = require('hugo-bin');
const hugo = require('hugo-node');
execFile(hugo, ['version'], (error, stdout) => {
if (error) {
@ -27,88 +29,40 @@ execFile(hugo, ['version'], (error, stdout) => {
});
```
### CLI
```sh
$(npm bin)/hugo --help
npm run create -- post/my-new-post.md # see below 'npm run-script'
```
or on Windows:
```bat
for /f "delims=" %F in ('npm bin') do call "%F\hugo" help
rem see below 'npm run-script'
npm run create -- post/my-new-post.md
```
### npm run-script
### package.json
```json
{
"scripts": {
"build": "hugo",
"create": "hugo new",
"serve": "hugo server"
}
}
```
See the [Hugo Documentation](https://gohugo.io/) for more information.
## Installation options
hugo-bin supports options to change the variation of Hugo binaries.
Each option can be configured in the `hugo-bin` section of your `package.json`:
```json
{
"name": "your-package",
"version": "0.0.1",
"hugo-bin": {
"buildTags": "extended"
"start": "hugo serve",
"create": "hugo new"
}
}
```
Also as local or global [.npmrc](https://docs.npmjs.com/files/npmrc) configuration file:
```ini
hugo_bin_build_tags = "extended"
```
Also as an environment variable:
#### CLI
```sh
export HUGO_BIN_BUILD_TAGS="extended"
$(npm bin)/hugo --help
npm run create -- post/my-new-post.md
```
**Note that you have to run `npm install hugo-bin` to re-install hugo-bin itself, if you change any of these options.**
### Options
#### buildTags
Default: `""`
Set it to `extended` to download the [extended version](https://github.com/gohugoio/hugo/releases/tag/v0.43) binary.
If this is set to `extended` but it's not available for the user's platform, then the normal version will be downloaded instead.
## Supported versions
See [the package.json commit history](https://github.com/fenneclab/hugo-bin/commits/master/package.json).
or on Windows:
## Full example
```bat
for /f "delims=" %F in ('npm bin') do call "%F\hugo" help
npm run create -- post/my-new-post.md
```
- [fenneclab/blog.fenneclab.com](https://github.com/fenneclab/blog.fenneclab.com)
See the [Hugo Documentation](https://gohugo.io/documentation/) for additional functionality.
## Super Inspired By
## Examples
- [mastilver/apex-bin](https://github.com/mastilver/apex-bin)
- [imagemin/jpegtran-bin](https://github.com/imagemin/jpegtran-bin)
- [jakejarvis/jarv.is](https://github.com/jakejarvis/jarv.is)
## License
MIT © [Shun Sato](http://blog.fenneclab.com/)
Forked from [fenneclab/hugo-bin](https://github.com/fenneclab/hugo-bin) under the [MIT License](https://github.com/fenneclab/hugo-bin/blob/master/LICENSE), (c) [Shun Sato](http://blog.fenneclab.com/).
Hugo is distributed under the [Apache License 2.0](https://github.com/gohugoio/hugo/blob/master/LICENSE).

11
package.json

@ -1,10 +1,19 @@
{
"name": "@jakejarvis/hugo",
"name": "hugo-node",
"version": "0.63.2",
"hugoVersion": "0.63.2",
"description": "Binary wrapper for Hugo",
"repository": "jakejarvis/hugo-node",
"license": "MIT",
"keywords": [
"hugo",
"gohugoio",
"cli",
"bin",
"binary",
"wrapper",
"static site generator"
],
"main": "index.js",
"bin": {
"hugo": "cli.js"

Loading…
Cancel
Save