Skip to content

A Jekyll plugin that provides users with a traditional CMS-style graphical interface to author content and administer Jekyll sites.

License

Notifications You must be signed in to change notification settings

rpeyron/jekyll-admin

 
 

Repository files navigation

This repository is a fork with the following features added:

  • real preview on the side (refreshed automatically if you activate live-reload)
  • choice of other Markdown editors (TUI, TinyMDE, basic textarea or original SimpleMDE) to benefit from spell checkers like LangageTool that do not work with SimpleMDE
  • header_buttons settings to add custom URLs as buttons/menus in the header to have all your ressources to edit webpages at your fingertips
  • force_show_drafts settings to force drafts when using multiple _config.yml or --drafts command line
  • new_meta_defaults settings to add automatically predefined meta on new drafts (and avoid forgetting to set some of it)
  • sort static files index by most recent files
  • save in localStorage the last edited version to be able to restore it if you close by mistake the editor, or if the tab crashes for an unknown reason
  • sort collections folders according to last modified date (reverse)
  • added administration panel to view logs, shutdown serve, process site, etc. This allow handy headless operations.
  • added sidebar entries to view external contents in frames (if allowed by the corresponding website)

All these features have been submitted as PR, I hope jekyll-admin will get some of it, or at least some inspiration from these features. This fork is not intended to be globally maintained and developped (aside those little features).


Gem Version Continuous Integration Build status Coverage Status NPM Dependencies Financial Contributors on Open Collective

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.

screenshot of Jekyll Admin

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:

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

    gem 'jekyll-admin', group: :jekyll_plugins
  2. Run bundle install

Usage

  1. Start Jekyll as you would normally (bundle exec jekyll serve)
  2. Navigate to http://localhost:4000/admin to 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: News

Contributing

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.

About

A Jekyll plugin that provides users with a traditional CMS-style graphical interface to author content and administer Jekyll sites.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 72.1%
  • Ruby 18.9%
  • SCSS 8.6%
  • Other 0.4%