Project

hyde-decap

0.0
The project is in a healthy, maintained state
hyde-decapgregdaynes/hyde-decapHomepageDocumentationSource CodeBug TrackerWiki
Hyde Decap is a plugin for Jekyll to add Decap CMS.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
479
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.1.1
Total releases
2
First release
2023-12-22
Latest release
2023-12-24
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-12-23
Reverse Dependencies
0

 Dependencies

Development

jekyll
>= 4.0, < 5.0
 Project Readme

Hyde Decap

A Jekyll 4 plugin for setting up Decap CMS in your output directory.

Installation

  1. Add Hyde Decap to your Gemfile

gem 'hyde-decap', '~> 0.1.0'

  1. Add entry to your Jekyll config under plugins
plugins:
  - hyde-decap
  ...

  1. Setup your configuration for Decap CMS under the hyde_decap property in your Jekyll config file

  2. [Optional] Run Decap CMS's local backend for during development using jekyll decap [reuse optional flags from jekyll serve]. See more below for requirements.

Configuration

Hyde Decap comes with the following configuration. Override as necessary in your Jekyll Config

# Default Configuration

hyde_decap:
  file_output_path: admin
  enable: true
  keep_files: true

Important

Decap CMS requires specific fields to be set in the configuration that are specific to each project. Add the additional yaml configuration under the hyde_decap property in your Jekyll config. An example is available in the example directory in this repo. You can find all of the Decap Configurations in the documentation.

file_output_path : relative path from the root of your generated site to the location to place Decap CMS Admin.

enable : will generate the files when enabled, otherwise will skip the process at build time

keep_files : will not delete files between builds, and will reuse existing files if they match.

The Decap CMS admin includes hithismani's responsive-decap CSS to provide a mobile friendly design.

Run Decap CMS Proxy and Jekyll Serve together

Note

This requires NodeJS 18+ to be installed along with Netlify CMS Proxy Server

You can simplify local development by utilizing the command jekyll decap which will run 2 processes for jekyll serve and npx netlify-cms-proxy-server

The command takes the same options as jekyll serve - livereload works for both your Jekyll builds and Decap.

Aknowledgements

Decap CMS - MIT License Responsive Decap - MIT License Subprocess Code from Stack Overflow