Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/SteveMcArthur/docpad-plugin-cms

Docpad plugin that provides a CMS (Content Management System)/admin interface for a Docpad application.
https://github.com/SteveMcArthur/docpad-plugin-cms

cms cmsplugin content-management-system docpad docpad-plugin

Last synced: 5 days ago
JSON representation

Docpad plugin that provides a CMS (Content Management System)/admin interface for a Docpad application.

Host: GitHub
URL: https://github.com/SteveMcArthur/docpad-plugin-cms
Owner: SteveMcArthur
License: other
Created: 2016-06-23T07:27:06.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2017-08-29T09:28:52.000Z (about 7 years ago)
Last Synced: 2024-09-24T16:36:11.439Z (about 2 months ago)
Topics: cms, cmsplugin, content-management-system, docpad, docpad-plugin
Language: CoffeeScript
Homepage:
Size: 3.81 MB
Stars: 4
Watchers: 3
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-starred - SteveMcArthur/docpad-plugin-cms - Docpad plugin that provides a CMS (Content Management System)/admin interface for a Docpad application. (others)

README

# CMS Plugin for [DocPad](http://docpad.org)

[![Build Status](https://img.shields.io/travis/SteveMcArthur/docpad-plugin-cms/master.svg)](https://travis-ci.org/SteveMcArthur/docpad-plugin-cms "Check this project's build status on TravisCI")
[![NPM version](https://img.shields.io/npm/v/docpad-plugin-cms.svg)](https://www.npmjs.com/package/docpad-plugin-cms "View this project on NPM")
[![NPM downloads](https://img.shields.io/npm/dm/docpad-plugin-cms.svg)](https://www.npmjs.com/package/docpad-plugin-cms "View this project on NPM")

Docpad plugin that provides a CMS (Content Management System)/admin interface for a Docpad application.
The plugin is still under development - so some functionality is liable to change.

![Screen shot](https://raw.githubusercontent.com/SteveMcArthur/docpad-plugin-cms/master/screenshot.jpg)

## Supporting Plugins
To function properly a number of supporting plugins need to be installed. The [ECO plugin](https://www.npmjs.com/package/docpad-plugin-eco) is needed to render the CMS interface and this plugin can be installed alongside whatever template plugin that is installed within an application already.

Other plugins that need to be installed are the [cleanurls](https://www.npmjs.com/package/docpad-plugin-cleanurls) and [posteditor](https://www.npmjs.com/package/docpad-plugin-posteditor) plugins. The cleanurls plugin is usually a good one to install anyway - so it is likely you will have it already. The posteditor plugin provides the functionality for editing posts - typically the most important function within a CMS.

The [authentication plugin](https://www.npmjs.com/package/docpad-plugin-authentication) is also expected to be installed, but technically you could argue that this is not essential for the operation of the CMS plugin. It just provides a way of protecting the CMS pages from unauthenticated users.

If the eco, authentication, cleanurls and posteditor plugins are not present then a warning will be issued through the console highlighting the fact that these plugins are missing.

The eco, cleanurls and posteditor plugins are also listed as 'peerDependencies' in the package.json. So node will also output a big red message highlighting these 'unmet peerDependencies'.

There is also an 'analytics' page within the CMS and analytics data shown on the CMS dashboard. These require the [analytics plugin](https://www.npmjs.com/package/docpad-plugin-analytics) to be installed. If not, these functions will not be present and a message will appear on the dashboard stating that the analytics plugin is not installed.

Likewise, there is also a 'plugins' page within the CMS, used for managing a DocPad website's installed plugins. This expects the [pluginmanager plugin](https://www.npmjs.com/package/docpad-plugin-pluginmanager) to be installed. If not, the page will not be present and a message will appear on the dashboard.

The plugins, therefore, that are either required or recommended to be installed are:

* ECO [https://www.npmjs.com/package/docpad-plugin-eco](https://www.npmjs.com/package/docpad-plugin-eco)
* Cleanurls [https://www.npmjs.com/package/docpad-plugin-cleanurls](https://www.npmjs.com/package/docpad-plugin-cleanurls)
* Posteditor [https://www.npmjs.com/package/docpad-plugin-posteditor](https://www.npmjs.com/package/docpad-plugin-posteditor)
* Authentication [https://www.npmjs.com/package/docpad-plugin-authentication](https://www.npmjs.com/package/docpad-plugin-authentication)
* Analytics [https://www.npmjs.com/package/docpad-plugin-analytics](https://www.npmjs.com/package/docpad-plugin-analytics)
* Pluginmanager [https://www.npmjs.com/package/docpad-plugin-pluginmanager](https://www.npmjs.com/package/docpad-plugin-pluginmanager)

The order in which the plugins are installed doesn't really matter, but to avoid any warning messages and unexpected behaviour by the CMS you are probably better off installing the above plugins first.

## License

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://creativecommons.org/licenses/MIT/)