vuepress-netlifycms
v1.0.2
Published
--- title: README --- # VuePress-NetlifyCMS
Downloads
10
Readme
title: README
VuePress-NetlifyCMS
A vuepress site hosted with Netlify CMS.
Quick Start
Let's get started with VuePress-NetlifyCMS step by step.
Fork on Github
Deploy 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:
- Go to Settings > Identity, and select Enable Identity service.
- 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.
- 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.
- 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.
Add the Netlify Identity Widget
You'll need to add this to the <head>
of your CMS index page at /admin/index.html, as well as the <head>
of your site's main index page.We could include the script in your site using Netlify's Script Injection feature;
<script src="https://cdn.jsdelivr.net/npm/[email protected]/build/netlify-identity-widget.min.js"></script>
Add the following script before the closing body tag of your site's main index page using Netlify's Script Injection feature.
<script>
if (window.netlifyIdentity) {
window.netlifyIdentity.on("init", user => {
if (!user) {
window.netlifyIdentity.on("login", () => {
document.location.href = "/admin/";
});
}
});
}
</script>
Now you can control site content in https://yoursite.netlify.com/admin/