https://github.com/geauxweisbeck4/vuepress-boilerplate-netlify-cms

https://github.com/geauxweisbeck4/vuepress-boilerplate-netlify-cms

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/geauxweisbeck4/vuepress-boilerplate-netlify-cms
• Owner: GeauxWeisbeck4
• License: mit
• Created: 2022-06-15T23:10:10.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-14T11:41:53.000Z (over 1 year ago)
• Last Synced: 2024-04-13T15:53:30.826Z (7 months ago)
• Language: HTML
• Size: 568 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
---

title: README

---

# vuepress-boilerplate-netlify-cms

![Netlify](https://img.shields.io/netlify/271f5a7f-5024-4e8e-96de-4d49584fae2b)

![GitHub](https://img.shields.io/github/license/DemoMacro/vuepress-boilerplate-netlify-cms)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)

> VuePress boilerplate integrated with Netlify CMS, powered by Demo Macro.

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/DemoMacro/vuepress-boilerplate-netlify-cms&stack=cms)

## Manual start

### [Fork](https://github.com/DemoMacro/vuepress-boilerplate-netlify-cms/fork) on Github

More info: [VuePress Documentation](https://vuepress.vuejs.org/)

### Deploy to Netlify

More info: [Framework integrations](https://docs.netlify.com/integrations/frameworks/#vuepress)

### 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.

More info: [Git Gateway](https://docs.netlify.com/visitor-access/git-gateway/)

### Add the Netlify Identity Widget

You will need to add it to the `` of your CMS index page at /admin/index.html and to the `` of the main index page of your website. We can use Netlify's script injection feature to include this script in your website.

```html

```

Using Netlify's script injection feature, add the following script to the main index page of your website before the close body tag.

```html

  if (window.netlifyIdentity) {

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

      if (!user) {

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

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

        });

      }

    });

  }

```

### Congratulations

You can now manage the content of your website at https://yoursite.netlify.com/admin/.

## License

[MIT](LICENSE) © [Demo Macro](https://github.com/DemoMacro)