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.
Installation
Refer to the installing plugins section of Jekyll's documentation and install the jekyll-admin plugin as you would any other plugin. Here's the short version:
-
Add the following to your site's Gemfile:
gem 'jekyll-admin', group: :jekyll_plugins
-
Run
bundle install
Usage
- Start Jekyll as you would normally (
bundle exec jekyll serve) - Navigate to
http://localhost:4000/adminto access the administrative interface
Options
Jekyll Admin related options can be specified in _config.yml under a key called jekyll_admin.
jekyll_admin:
hidden_links:
- posts
- pages
- staticfiles
- datafiles
- configuration
homepage: "pages"Customizing collection label in Sidebar
The plugin allows you to customize the name of a collection that is displayed in the sidebar by defining it in the collection's
metadata in the config file. For example, if your source's posts are actually news-items on the deployed site, then it can
be distracting to see the label Posts in the admin's sidebar. This situation can be resolved with the following configuration:
collections:
posts:
output: true
sidebar_label: NewsContributing
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. See the contributing instructions, and the development docs for more information.
Contributors
Code Contributors
This project exists thanks to all the people who contribute. [Contribute].
Financial Contributors
Become a financial contributor and help us sustain our community. [Contribute]
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
License
The gem is available as open source under the terms of the MIT License.