Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.98 KB

README.md

File metadata and controls

69 lines (46 loc) · 2.98 KB
Raw
title
README

vuepress-boilerplate-netlify-cms

Netlify GitHub Contributor Covenant

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

Deploy to Netlify

Manual start

Fork on Github

More info: VuePress Documentation

Deploy to Netlify

More info: Framework integrations

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

Add the Netlify Identity Widget

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

<!-- Include the script that enables Netlify Identity on this page. -->
<script src="https://identity.netlify.com/v1/netlify-identity-widget.js"></script>

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

<script>
  if (window.netlifyIdentity) {
    window.netlifyIdentity.on("init", (user) => {
      if (!user) {
        window.netlifyIdentity.on("login", () => {
          document.location.href = "/admin/";
        });
      }
    });
  }
</script>

Congratulations

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

License

MIT © Demo Macro