https://github.com/adamj/design-guidebook

https://github.com/adamj/design-guidebook

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/adamj/design-guidebook
• Owner: AdamJ
• Created: 2020-03-06T23:19:29.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T22:38:11.000Z (about 2 years ago)
• Last Synced: 2024-10-31T10:44:06.304Z (2 months ago)
• Language: JavaScript
• Size: 2.71 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Design Guidebook

## Setup authentication

After deploying this project, Netlify Identity will add you as a CMS user and

will email you an invite. It is not necessary to accept this invite if you wish

to use an

[OAuth provider](https://www.netlify.com/docs/identity/#external-provider-login)

(e.g. Github) to manage authentication for your CMS.

It is recommended to use this method of authentication as it removes the need

for an email & password to log in to the CMS and is generally more secure. You

will need to add an OAuth provider in your Netlify app settings under

"Settings" > "Identity" > "External providers".

Next, navigate to `/admin` on your site, choose your OAuth provider from the

login box and you should then be logged into your CMS.

Now you're all set, and you can start editing content!

**Note:** if you switch the repo that was created to private, you'll need to regenerate your token,

as the token generated using the deploy to Netlify button can only access public repositories. To

regenerate your token, head to "Settings" in your Netlify site dashboard, go to the "Identity"

section, then scroll to "Services" where you'll see an "Edit settings" button. Click that and you'll

see a text link to "Generate access token in GitHub".

## Local Development

Clone this repository and run:

```bash

bundle install

bundle exec jekyll server --watch

```

Jekyll will watch your project folder for changes.

Now navigate to [localhost:4000](http://localhost:4000/) to preview the site, and

[localhost:4000/admin](http://localhost:4000/admin) to log into the CMS.

## Bug reports, feature requests, etc

This is an ongoing project and I welcome contributions. Feel free to submit a PR.

If you need any help with setting up Netlify CMS, you can reach out to the Netlify team in the [Netlify CMS Gitter](https://gitter.im/netlify/netlifycms).