Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudcannon/cloudcannon-hugo
:electric_plug: Generates a JSON file for CloudCannon to create an editing interface from a site built with Hugo.
https://github.com/cloudcannon/cloudcannon-hugo
cloudcannon cms hugo ssg static-site-generator
Last synced: 5 days ago
JSON representation
:electric_plug: Generates a JSON file for CloudCannon to create an editing interface from a site built with Hugo.
- Host: GitHub
- URL: https://github.com/cloudcannon/cloudcannon-hugo
- Owner: CloudCannon
- License: isc
- Created: 2020-09-28T01:37:15.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T03:17:56.000Z (5 months ago)
- Last Synced: 2024-04-23T05:01:33.011Z (5 months ago)
- Topics: cloudcannon, cms, hugo, ssg, static-site-generator
- Language: JavaScript
- Homepage:
- Size: 913 KB
- Stars: 4
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CloudCannon Hugo
Creates [CloudCannon](https://cloudcannon.com/) build information for sites made with Hugo.
This tool runs after your Hugo build, reading your configuration to find pages, collections, and
data files to create a JSON file used to automatically integrate the site with CloudCannon. This
JSON file is written to `_cloudcannon/info.json` in your destination folder.
[
](https://www.npmjs.com/package/cloudcannon-hugo)
[
](https://www.npmjs.com/package/cloudcannon-hugo)
[](https://travis-ci.com/CloudCannon/cloudcannon-hugo)
[](https://codecov.io/gh/CloudCannon/cloudcannon-hugo)
***
- [Installation](#installation)
- [Configuration](#configuration)
- [Development](#development)
- [License](#license)
***
## Installation
**You don't have to install anything** when building on CloudCannon. This tool is automatically
installed before your site is built. This gives you the latest support, new features, and fixes
as they are released.
Although **not necessary**, you can install the tool locally to debug an integration issue.
Manual installation steps
```sh
$ npm install --global cloudcannon-hugo
```
This gives you access to the `cloudcannon-hugo` binary.
## Configuration
Configuration files should be in the root directory (or the same directory you run
`cloudcannon-hugo`). The first supported file found in this order is used:
- `cloudcannon.config.json`
- `cloudcannon.config.yaml`
- `cloudcannon.config.yml`
- `cloudcannon.config.js`
- `cloudcannon.config.cjs`
Alternatively, use a specific file with the `CLOUDCANNON_CONFIG_PATH` environment variable:
```sh
$ CLOUDCANNON_CONFIG_PATH=src/cloudcannon.config.js cloudcannon-hugo
```
Your global CloudCannon configuration is set in this file as well, as it's used as a base to
generate `_cloudcannon/info.json` (used to integrate your site with CloudCannon).
Example content for `cloudcannon.config.yml`:
```yaml
# Global CloudCannon configuration
_inputs:
title:
type: text
comment: The title of your page.
_select_data:
colors:
- Red
- Green
- Blue
# Base path to your site source files
source: src
# The subpath your built output files are mounted at
base_url: /documentation
# Populates collections for navigation and metadata in the editor
collections_config:
people:
# Base path for files in this collection, relative to source
path: content/people
# Whether this collection produces output files or not
output: true
# Collection-level configuration
name: Personnel
_enabled_editors:
- data
posts:
path: _posts
output: true
pages:
name: Main pages
# Generates the data for select and multiselect inputs matching these names
data_config:
# Populates data with authors from an data file with the matching name
authors: true
offices: true
paths:
# The default location for newly uploaded files, relative to source
uploads: assets/uploads
# The path to site data files, relative to source
data: _data
# The path to site layout files, relative to source
layouts: _layouts
```
See the [CloudCannon documentation](https://cloudcannon.com/documentation/) for more information
on the available features you can configure.
Configuration is set in `cloudcannon.config.*`, but the tool also automatically
reads and processes the following from Hugo if unset:
- `collections_config` from your folder structure inside `contentDir` in Hugo config
- `paths.layouts` from `layoutsDir` in Hugo config
- `paths.data` from `dataDir` in Hugo config
- `paths.static` from `staticDir` in Hugo config
- `base_url` from the `--baseURL` CLI option or `baseURL` in Hugo config
- `source` from `source` in Hugo config
## Development
Install dependencies:
```sh
$ npm i
```
Lint code:
```sh
$ npm run lint
```
### Testing
Run tests:
```sh
$ npm test
$ npm run test:integration
$ npm run test:all
$ npm run report-coverage
```
Link this package locally to test it on a site folder, then run it within your site folder:
```sh
$ npm link
$ cd ../my-hugo-site
$ cloudcannon-hugo
```
### Releasing new versions
Prerelease:
```sh
$ npm run release:next
```
Release:
```sh
$ npm run release:latest
```
## License
ISC