Skip to content

Commit 0a8509d

Browse files
committed
v2.0.0
1 parent 80f63a6 commit 0a8509d

37 files changed

+3186
-721
lines changed

.eslintrc.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"env": {
3+
"browser": true
4+
},
5+
"extends": "eslint:recommended",
6+
"parserOptions": {
7+
"ecmaVersion": 5
8+
},
9+
"rules": {
10+
"indent": [
11+
"error",
12+
2
13+
],
14+
"linebreak-style": [
15+
"error",
16+
"unix"
17+
],
18+
"quotes": [
19+
"error",
20+
"single"
21+
],
22+
"semi": [
23+
"error",
24+
"always"
25+
],
26+
"no-unused-vars": 0
27+
}
28+
}

.gitignore

100644100755
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
.DS_Store
22
node_modules/*
3-
bower_components/*
43
release/*
5-
release.zip
6-
.idea/
7-
dev/*
4+
*.swp

LICENSE.md

100644100755
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 Chris Diana
3+
Copyright (c) 2018 Chris Diana
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.md

100644100755
Lines changed: 34 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,83 @@
11
![CMS.js Logo](https://raw.githubusercontent.com/chrisdiana/cms.js/gh-pages/img/logo-md.png)
22

3-
**UPDATES COMING SOON!**
4-
5-
CMS.js is fully client-side, Javascript site generator in the spirit of [Jekyll](https://github.com/jekyll/jekyll)
6-
that uses plain ol' HTML, CSS and Javascript to generate your website. CMS.js is like a file-based CMS.
7-
It takes your content, renders Markdown and delivers a complete website in Single-Page
8-
App fashion...without the aid of server-side scripting (no Node.js, PHP, Ruby, etc.).
3+
CMS.js is fully **C**lient-side, JavaScript **M**arkdown **S**ite generator in the spirit of [Jekyll](https://github.com/jekyll/jekyll) that uses plain ol' HTML, CSS and JavaScript to generate your website. CMS.js is like a file-based CMS.
4+
It takes your content, renders Markdown and delivers a complete website in Single-Page App fashion...without the aid of server-side scripting (no Node.js, PHP, Ruby, etc.).
95

106
![CMS.js Screenshot](https://raw.githubusercontent.com/chrisdiana/cms.js/gh-pages/img/screenshot.png)
117

8+
## New Features in Version 2.0
9+
10+
* Zero dependencies
11+
* Abstract types
12+
* Custom Templates
13+
* Search, Filtering, Tagging and Sorting
14+
* Github & Server Mode
15+
* Extendable Markdown Renderer and Plugins
16+
* Super small footprint - 8kb minified
1217

1318

1419
## Demo
1520

16-
Check out a working [demo here](http://chrisdiana.github.io/cms.js/demo/)
21+
Check out a working [demo here](http://chrisdiana.github.io/cms.js/demo)
1722

1823

1924
## Quick Start
2025

21-
CMS.js currently supports two website modes, Github and Server.
22-
23-
**Github Mode**
24-
25-
This is the default mode for CMS.js. Host your website on Github using
26-
Github Pages, similar to Jekyll.
27-
28-
**Server Mode**
29-
30-
Use server mode if you choose to self host your content. Apache and NGINX servers are supported.
31-
If using server mode, make sure the server's directory indexing feature is enabled.
26+
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](https://github.com/chrisdiana/cms.js/wiki/Server-Mode).
3227

33-
* Apache - Make sure `htaccess` is enabled OR `Options Indexes` is set for your directory.
34-
* NGINX - Make sure `autoindex on` is set for your directory
28+
1. Clone the starter repo: `git clone https://github.com/chrisdiana/cms.js-starter.git` or download the [latest release](https://github.com/chrisdiana/cms.js/releases/latest)
29+
2. Configure `js/config.js` to your liking
30+
3. Make sure to set your Github settings in `js/config.js` if using Github mode
31+
4. If using Github mode, create a new branch from your master or working branch called `gh-pages` (Github's default branch for hosting)
32+
5. Visit your site!
3533

36-
More info on server setup is available on the [wiki](https://github.com/chrisdiana/cms.js/wiki/Server-Support-&-Setup)
3734

35+
## Themes
3836

39-
**Install**
37+
Try out CMS.js with a variety of popular CSS frameworks such as Bootstrap, Foundation, and Bulma. Check out all the themes [available here](https://github.com/chrisdiana/cms.js-themes).
4038

41-
1. Clone the repo: `git clone https://github.com/chrisdiana/cms.js.git` or download the [latest release](https://github.com/chrisdiana/cms.js/releases/latest)
42-
2. Configure `js/config.js` to your liking
43-
3. Make sure to set your `githubUserSettings` in `js/config.js` if using Github mode
44-
4. If using Github mode, create a new branch from your master or working branch called `gh-pages`
45-
(Github's default branch for hosting)
46-
5. Visit your site!
39+
![CMS.js Themes](./img/themes.png)
4740

4841

4942
## How it works
5043

5144
**Github Mode**
5245

53-
In Github mode, CMS.js uses the Github API to get the content of your gh-pages repo
54-
and serve them as a full website.
46+
In Github mode, CMS.js uses the Github API to get the content of your repo and serve them as a full website.
5547

5648
**Server Mode**
5749

58-
In Server mode, CMS.js takes advantage of the Server's Directory Indexing feature. By allowing indexes,
59-
CMS.js sends an AJAX call to your specified folders and looks for Markdown files.
50+
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.
6051
After they are found, it takes care of everything else and delivers a full website.
6152

6253

6354
## Migration from Jekyll
6455

6556
**Importing Posts**
6657

67-
Once CMS.js is installed and running, simply copy all of your posts from your Jekyll
68-
project's `_post` folder to your designated CMS.js posts folder.
58+
Once CMS.js is installed and running, simply copy all of your posts from your Jekyll project's `_post` folder to your designated CMS.js posts folder.
6959

7060
**Importing Pages**
7161

72-
Copy all of your Markdown pages from your Jekyll projects root folder into your designated
73-
CMS.js pages folder.
62+
Copy all of your Markdown pages from your Jekyll projects root folder into your designated CMS.js pages folder.
63+
64+
65+
## Coming soon!
66+
67+
* Pagination
68+
* Template caching
69+
* Loader
70+
* CLI Utilities
7471

7572

7673
## Thanks!
7774

7875
* [Poole](https://github.com/poole/poole) (*Default Theme*)
79-
* [jQuery](https://jquery.com/)
80-
* [Marked](https://github.com/chjj/marked)
8176

8277

8378
## Contributing
8479

85-
All forms of contribution are welcome: bug reports, bug fixes, pull requests and simple suggestions.
86-
If you do wish to contribute, please follow the [Airbnb Javascript Style Guide](https://github.com/airbnb/javascript/tree/master/es5) Thanks!
80+
All forms of contribution are welcome: bug reports, bug fixes, pull requests and simple suggestions. If you do wish to contribute, please run `npm run lint` before submitting a PR. Thanks!
8781

8882

8983
## List of contributors

css/style.css

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)