https://github.com/imcuttle/vuepress-netlifycms-2

https://github.com/imcuttle/vuepress-netlifycms-2

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/imcuttle/vuepress-netlifycms-2
• Owner: imcuttle
• License: mit
• Created: 2019-02-20T08:31:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-01-07T14:47:54.000Z (over 4 years ago)
• Last Synced: 2025-03-23T02:34:06.763Z (over 1 year ago)
• Language: JavaScript
• Size: 171 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
---

title: README

---

# VuePress-NetlifyCMS

![](https://img.shields.io/github/license/DemoMacro/VuePress-NetlifyCMS.svg?style=flat)

> A vuepress site hosted with Netlify CMS.

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/DemoMacro/VuePress-NetlifyCMS/)

### Quick Start

Let's get started with VuePress-NetlifyCMS step by step.

### [Fork](https://github.com/DemoMacro/VuePress-NetlifyCMS/fork) on Github

### [Deploy](https://app.netlify.com/start/deploy?repository=https://github.com/DemoMacro/VuePress-NetlifyCMS) to Netlify

```

Build command: vuepress build

Publish directory: pages

```

### Enable Identity and Git Gateway

Netlify's Identity and Git Gateway services allow you to manage CMS admin users for your site without requiring them to have an account with your Git host or commit access on your repo. From your site dashboard on Netlify:

1. Go to **Settings > Identity**, and select **Enable Identity service**.

2. Under **Registration preferences**, select **Open** or **Invite only**. In most cases, you want only invited users to access your CMS, but if you're just experimenting, you can leave it open for convenience.

3. If you'd like to allow one-click login with services like Google and GitHub, check the boxes next to the services you'd like to use, under **External providers**.

4. Scroll down to **Services > Git Gateway**, and click **Enable Git Gateway**. This authenticates with your Git host and generates an API access token. In this case, we're leaving the **Roles** field blank, which means any logged in user may access the CMS. For information on changing this, check the [Netlify Identity documentation](https://www.netlify.com/docs/identity/).

### Add the Netlify Identity Widget

You'll need to add this to the `````` of your CMS index page at /admin/index.html, as well as the `````` of your site's main index page.We could include the script in your site using Netlify's Script Injection feature;

```html

```

 Add the following script before the closing body tag of your site's main index page using Netlify's Script Injection feature.

```html

  if (window.netlifyIdentity) {

    window.netlifyIdentity.on("init", user => {

      if (!user) {

        window.netlifyIdentity.on("login", () => {

          document.location.href = "/admin/";

        });

      }

    });

  }

```

> Now you can control site content in https://yoursite.netlify.com/admin/