Demo

Quick Start

CMS.js supports two website modes, Github and Server. Host your website on Github using Github Pages (similar to Jekyll) or use Server mode if you choose to self host your content. Learn more about server mode and setup here.

Make sure to set your Github settings in js/config.js if using Github mode

If using Github mode, create a new branch from your master or working branch called gh-pages (Github's default branch for hosting)

Visit your site! (which should be located at https://yourusername.github.io/cms.js-starter)

Themes

Try out CMS.js with a variety of popular CSS frameworks such as Bootstrap, Foundation, and Bulma. Check out all the themes available here.

How it works

Github Mode

In Github mode, CMS.js uses the Github API to get the content of your repo and serve them as a full website.

Server Mode

In Server mode, CMS.js takes advantage of the Server's Directory Indexing feature. By allowing indexes, CMS.js sends an AJAX call to your specified folders and looks for Markdown or HTML files.
After they are found, it takes care of everything else and delivers a full website.

Coming soon!

Thanks!

Contributing

All forms of contribution are welcome: bug reports, bug fixes, pull requests and simple suggestions. If you do wish to contribute, please check out the Contributing Guide before making a pull request. Thanks!