Add readme
Tom Rutgers
committed Aug 20, 2018
commit fdc9c4eb2ab2a2a17b65cff7d342ca7c636c5132
Showing 1
changed file with
40 additions
and 2 deletions
README.md
+40
-2
| @@ | @@ -1,2 +1,40 @@ |
| - | # middleman-starter-netlify-cms |
| - | A simple example to get started with Middleman and Netlify CMS |
| + | # Middleman + Netlify CMS Starter |
| + | |
| + | This repo contains an **[example website](https://middleman-netlify-cms.netlify.com/)** that is built with [Middleman](https://www.middlemanapp.com/), and [Netlify CMS](https://www.netlifycms.org). *Designed and developed by [Tom Rutgers](https://www.tomrutgers.nl/)* |
| + | |
| + | ## About the architecture |
| + | |
| + | **Middleman** is a static site generator using all the shortcuts and tools in modern web development. Check out [middlemanapp.com](http://middlemanapp.com/) for detailed tutorials, including a [getting started guide](http://middlemanapp.com/basics/getting-started/). |
| + | |
| + | **Netlify CMS** is a CMS for static site generators. Give non-technical users a simple way to edit and add content to any site built with a static site generator. |
| + | |
| + | ## Getting Started (Recommended) |
| + | |
| + | Netlify CMS can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. Use the deploy button below to copy the repository to your account. |
| + | |
| + | <a href="https://app.netlify.com/start/deploy?repository=https://github.com/tomrutgers/middleman-starter-netlify-cms&stack=cms"><img src="https://www.netlify.com/img/deploy/button.svg" alt="Deploy to Netlify"></a> |
| + | |
| + | After clicking that button, you’ll authenticate with GitHub and choose a repository name. Netlify will then automatically create a repository in your GitHub account with a copy of the files from the template. Next, it will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete. To access the CMS, you’ll need to set up [Netlify identity](https://www.netlify.com/docs/identity/) service to authorize users to log in to the CMS. Make sure to enable [Git Gateway](https://www.netlify.com/docs/git-gateway/). |
| + | |
| + | ### Make it work on your machine |
| + | |
| + | Be sure to checkout the [middleman installation guide](https://middlemanapp.com/basics/install/) |
| + | ``` |
| + | $ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git |
| + | $ cd [REPO_NAME] |
| + | $ bundle install |
| + | $ middleman server |
| + | ``` |
| + | ## Getting Started (Without Netlify) |
| + | ``` |
| + | $ gatsby new [SITE_DIRECTORY_NAME] https://github.com/tomrutgers/middleman-starter-netlify-cms/ |
| + | $ cd [SITE_DIRECTORY_NAME] |
| + | $ bundle install |
| + | $ middleman server |
| + | ``` |
| + | |
| + | ### Setting up the CMS |
| + | Follow the [Netlify CMS Quick Start Guide](https://www.netlifycms.org/docs/quick-start/#authentication) to set up authentication, and hosting. |
| + | |
| + | ### Trouble? |
| + | [](https://gitter.im/netlify/NetlifyCMS) |
| \ No newline at end of file | |