Repository files navigation

A Jekyll plugin that provides users with a traditional CMS-style graphical interface to author content and administer Jekyll sites. The project is divided into two parts. A Ruby-based HTTP API that handles Jekyll and filesystem operations, and a JavaScript-based front end, built on that API.

Refer to theinstalling plugins section of Jekyll's documentation and install thejekyll-admin plugin as you would any other plugin. Here's the short version:

1. Add the following to your site's Gemfile:

   gem'jekyll-admin',group::jekyll_plugins

2. Runbundle install

1. Start Jekyll as you would normally (bundle exec jekyll serve)
2. Navigate tohttp://localhost:4000/admin to access the administrative interface

Jekyll Admin related options can be specified in_config.yml under a key calledjekyll_admin.

jekyll_admin:hidden_links:    -posts    -pages    -staticfiles    -datafiles    -configurationhomepage:"pages"

The plugin allows you to customize the name of a collection that is displayed in the sidebar by defining it in the collection'smetadata in the config file. For example, if your source'sposts are actuallynews-items on the deployed site, then it canbe distracting to see the labelPosts in the admin's sidebar. This situation can be resolved with the following configuration:

collections:posts:output:truesidebar_label:News

Interested in contributing to Jekyll Admin? We’d love your help. Jekyll Admin is an open source project, built one contribution at a time by users like you. Seethe contributing instructions, andthe development docs for more information.

This project exists thanks to all the people who contribute. [Contribute].

Become a financial contributor and help us sustain our community. [Contribute]

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

The gem is available as open source under the terms of theMIT License.