https://github.com/mohab-sameh/docz-netlifycms
https://github.com/mohab-sameh/docz-netlifycms
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mohab-sameh/docz-netlifycms
- Owner: mohab-sameh
- License: mit
- Created: 2023-01-12T23:42:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-13T16:52:18.000Z (over 3 years ago)
- Last Synced: 2025-03-30T04:26:41.247Z (about 1 year ago)
- Language: JavaScript
- Size: 833 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🗒️ Gatsby Starter for Docz & Netlify CMS
Easily spin up a new documentation site with the power of Docz and Netlify CMS.
### Want to skip the manual install?
[](https://app.netlify.com/start/deploy?repository=https://github.com/colbyfayock/gatsby-starter-docz-netlifycms)
Then [configure Netlify Identity](#user-content-enable--configure-netlify-identity-for-authentication)
### Here's What You Get
* [Docz](https://docz.site) documentation engine powered by [Gatsby](https://www.gatsbyjs.org/)
* [Netlify CMS](https://www.netlifycms.org/) content management
## 🚀 Setting Up Your Gatsby Site
1. **Create a Gatsby site.**
Use the Gatsby CLI to create a new site, specifying the default starter.
```shell
gatsby new my-docz-site https://github.com/colbyfayock/gatsby-starter-docz-netlifycms
```
1. **Start developing.**
Navigate into your new site’s directory and start it up.
```shell
cd my-docz-site/
npm run develop
```
1. **Open the source code and start editing!**
Your site is now running at `http://localhost:8000`!
## ⚡ Quick Start with Netlify
### Deploy to Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/colbyfayock/gatsby-starter-docz-netlifycms)
Note: This will request Github access and will create a repository for you
### Enable & Configure Netlify Identity for Authentication
* Navigate to **Identity** in the Netlify navigation
* Click **Enable Identity**
* Click **Invite Users** and enter your first user's email
* Click **Settings & Usage**
* **Optional:** If you'd like to close registration, scroll to **Registration Preferences** and change to **Invite Only**
* Scroll down to **Git Gateway** and click **Enable**
* You're ready to register and log in!
Once the invited user completes registration via the link in their email, they'll be able to log in via:
```https://[your site].netlify.com/admin```
## Need more help?
Visit the deployed documentation! [gatsby-starter-docz-netlifycms.netlify.com](https://gatsby-starter-docz-netlifycms.netlify.com/)