Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ashmaroli/jekyll-manager

A repackaged Jekyll Admin fork with some alterations.
https://github.com/ashmaroli/jekyll-manager

admin-ui cms javascript jekyll jekyll-plugin react ruby

Last synced: 18 days ago
JSON representation

A repackaged Jekyll Admin fork with some alterations.

Host: GitHub
URL: https://github.com/ashmaroli/jekyll-manager
Owner: ashmaroli
License: mit
Fork: true (jekyll/jekyll-admin)
Created: 2016-08-25T07:30:56.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2023-02-01T12:00:23.000Z (over 1 year ago)
Last Synced: 2024-05-18T07:02:51.586Z (about 1 month ago)
Topics: admin-ui, cms, javascript, jekyll, jekyll-plugin, react, ruby
Language: JavaScript
Homepage: https://ashmaroli.github.io/jekyll-manager
Size: 6.78 MB
Stars: 58
Watchers: 5
Forks: 16
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Lists

awesome-jekyll-plugins - **Manager** - manager](https://rubygems.org/gems/jekyll-manager)) by Ashwin Maroli -- An administrative framework for Jekyll sites, Jekyll Manager is essentially Jekyll Admin repackaged with some alterations. (Admin & Visual Editors)
awesome_jekyll_plugins - **Manager** - manager](https://rubygems.org/gems/jekyll-manager)) by Ashwin Maroli -- An administrative framework for Jekyll sites, Jekyll Manager is essentially Jekyll Admin repackaged with some alterations. (Admin & Visual Editors)
awesome-lists-awesome-jekyll-plugins - **Manager** - manager](https://rubygems.org/gems/jekyll-manager)) by Ashwin Maroli -- An administrative framework for Jekyll sites, Jekyll Manager is essentially Jekyll Admin repackaged with some alterations. (Admin & Visual Editors)

README

[![Gem Version](https://img.shields.io/gem/v/jekyll-manager.svg)](https://rubygems.org/gems/jekyll-manager)
[![Build Status](https://travis-ci.org/ashmaroli/jekyll-manager.svg?branch=master)](https://travis-ci.org/ashmaroli/jekyll-manager)
[![Build status](https://ci.appveyor.com/api/projects/status/03eflgat9fh8mxml/branch/master?svg=true)](https://ci.appveyor.com/project/ashmaroli/jekyll-manager/branch/master)
[![Coverage Status](https://coveralls.io/repos/github/ashmaroli/jekyll-manager/badge.svg?branch=master)](https://coveralls.io/github/ashmaroli/jekyll-manager?branch=master)
[![NPM Dependencies](https://david-dm.org/ashmaroli/jekyll-manager.svg)](https://david-dm.org/ashmaroli/jekyll-manager)

Forked from the official Jekyll plugin [Jekyll Admin](https://github.com/jekyll/jekyll-admin), Jekyll Manager 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 Manager](/screenshot.png)

## Installation

Refer to the [installing plugins](https://jekyllrb.com/docs/plugins/#installing-a-plugin) section of Jekyll's documentation and install the `jekyll-manager` plugin as you would any other plugin. Here's the short version:

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

```ruby
gem 'jekyll-manager', 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

## Divergence

Jekyll Manager is an open source project, forked from the official Jekyll plugin [Jekyll Admin](https://github.com/jekyll/jekyll-admin), and repackaged with some alterations and additions, a few of which, may eventually be included in the official version.

### Notable alterations:

* Sidebar routes cannot be manually hidden. They're rendered based on whether Jekyll has read-in at least one file of the concerned type.
* Routes to Collections other than Posts are hidden within a collapsed list-item by default.
* Metadata fields for front matter are hidden with a collapsed section by default.
* Input path fields show / require the full `relative_path` of the requested file.
* Minor style changes.
* Other miscellaneous changes.

### Additional Features:

* A basic dashboard that provides insight on the current site and a means to add files to cetain empty content types (*Pages, Posts, Data Files, Static Files*).
* Draft posts can be created and edited via the admin interface provided your config file has `show_drafts: true`
* Template files (files within `_layouts`, `_includes`, `_sass` and `assets` at the root of your site) can be edited via the interface.
* Template files (and files within any directory) within a theme-gem can be *viewed* and copied over to the source directory for editing.
* Ability to select layouts for a document based on available layouts in the Site.
* Special metadata field for tags.

## Contributing

Unless your contribution improves the changes outlined above or updates this repo's documentation, we'd appreciate it if you propose those changes at the upstream repo. Upstream changes *may* eventually find their way here after being altered as
required.

Interested in contributing to Jekyll Manager anyways?. See [the contributing instructions](.github/CONTRIBUTING.md), and [the development docs](http://ashmaroli.github.io/jekyll-manager/development/) for more information.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).