Skip to content

Commit eca1de7

Browse files
Tb/wrfl 1834 add visual editor (#259)
* added visual editor, updated content * updated README.md
1 parent 52a7736 commit eca1de7

18 files changed

+9048
-345
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
/.pnp
66
.pnp.js
77

8+
# Netlify Visual Editor (formerly Stackbit)
9+
.sourcebit-nextjs-cache.json
10+
.stackbit/cache
11+
.cache
12+
813
# testing
914
/coverage
1015

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ A customizable blog starter using:
88

99
- [Next.js](https://github.com/vercel/next.js) v15 (Pages Router)
1010
- [Tailwind](https://tailwindcss.com/) v3.x
11+
- [Netlify Visual Editor](https://docs.netlify.com/visual-editor/overview/)
1112
- Built-in [MDX](https://mdxjs.com/) support
1213
- Includes modern design with dark & light themes
1314

@@ -24,6 +25,7 @@ A customizable blog starter using:
2425
- [Using the Wizard](#using-the-setup-wizard)
2526
- [Configuring the Blog](#configuring-the-blog)
2627
- [Adding New Posts](#adding-new-posts)
28+
- [Netlify Visual Editor](#netlify-visual-editor)
2729
- [Testing](#testing)
2830
- [Included Default Testing](#included-default-testing)
2931
- [Removing Renovate](#removing-renovate)
@@ -93,6 +95,39 @@ https://user-images.githubusercontent.com/3611928/152727802-102ec296-41c8-446d-9
9395

9496
[alt: video walkthrough of adding a new blog post]
9597

98+
## Netlify Visual Editor
99+
100+
This template is configured to work with [visual editing](https://docs.netlify.com/visual-editor/overview/) and [Git Content Source](https://docs.netlify.com/create/content-sources/git/).
101+
102+
### Develop with Netlify Visual Editor Locally
103+
104+
The typical development process is to begin by working locally. Clone this repository, then run `npm install` in its root directory.
105+
106+
Run the Next.js development server:
107+
108+
```txt
109+
cd nextjs-blog-theme
110+
npm run dev
111+
```
112+
113+
Install the [Netlify Visual Editor CLI](https://www.npmjs.com/package/@stackbit/cli). Then open a new terminal window in the same project directory and run the Netlify visual editor dev server:
114+
115+
```txt
116+
npm install -g @stackbit/cli
117+
stackbit dev
118+
```
119+
120+
This outputs your own Netlify visual editor URL. Open this, register, or sign in, and you will be directed to Netlify's visual editor for your new project.
121+
122+
![Next.js Dev + Visual Editor Dev](https://assets.stackbit.com/docs/next-dev-stackbit-dev.png)
123+
124+
### Next Steps
125+
126+
Here are a few suggestions on what to do next if you're new to Netlify Visual Editor:
127+
128+
- Learn [Netlify visual editor overview](https://docs.netlify.com/visual-editor/visual-editing/)
129+
- Check [Netlify visual editor reference documentation](https://visual-editor-reference.netlify.com/)
130+
96131
## Testing
97132

98133
### Included Default Testing
@@ -106,3 +141,7 @@ If your team is not interested in this tooling, you can remove them with ease!
106141
### Removing Renovate
107142

108143
In order to keep our project up-to-date with dependencies we use a tool called [Renovate](https://github.com/marketplace/renovate). If you’re not interested in this tooling, delete the `renovate.json` file and commit that onto your main branch.
144+
145+
## Support
146+
147+
If you get stuck along the way, get help in our [support forums](https://answers.netlify.com/).

next-env.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/// <reference types="next" />
2+
/// <reference types="next/image-types/global" />
3+
4+
// NOTE: This file should not be edited
5+
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.

0 commit comments

Comments
 (0)