Skip to content

Commit 1be644e

Browse files
fix: README Updates (#2)
Co-authored-by: Charlie <charlie.a.gerard@gmail.com>
1 parent 844099f commit 1be644e

File tree

3 files changed

+41
-5
lines changed

3 files changed

+41
-5
lines changed

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,48 @@
1-
# Next.js Blog Theme
1+
# Next.js Blog Theme Designed by [Bejamas](https://bejamas.io)
22

3-
A simple blog starter based on Next.js, Tailwind 3.0 and MDX support. Includes modern design with dark and light theme.
3+
[![Deploy to Netlify Button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/nextjs-blog-theme)
44

5-
[Wizard](https://nextjs-wizard.netlify.app/) - create your own blog in few clicks and deploy on Netlify.
5+
A customizable blog starter using:
6+
- [Next.js](https://github.com/vercel/next.js) v12
7+
- [Tailwind](https://tailwindcss.com/) v3.0
8+
- Built-in [MDX](https://mdxjs.com/) v1 support
9+
- Includes modern design with dark & light themes
610

7-
## Configure the blog
11+
![Preview of blog theme. Author named Jay Doe and blog's name is "Next.js Blog Theme" with one blog post](nextjs-blog-theme-preview.png)
812

9-
The config is based on ENV Variables to make it easy to integrate with any Jamstack platform like Netlify.
13+
[Take a gander at the demo.](https://bejamas-nextjs-blog.netlify.app)
14+
15+
### Getting Started
16+
17+
You can get started with this project in two ways: locally or using the [setup wizard](https://nextjs-wizard.netlify.app/).
18+
19+
#### Setting Up Locally
20+
21+
If you're doing it locally, start with clicking the [use this template](https://github.com/netlify-templates/nextjs-blog-theme/generate) button on GitHub. This will create a new repository with this template's files on your GitHub account. Once that is done, clone your new repository and navigate to it in your terminal.
22+
23+
From there, you can install the project's dependencies by running:
24+
25+
```shell
26+
yarn install
27+
```
28+
29+
Finally, you can run your project locally with:
30+
31+
```shell
32+
yarn run dev
33+
```
34+
35+
Open your browser and visit <http://localhost:3000>, your project should be running!
36+
37+
#### Using the Setup Wizard
38+
39+
![Preview of Setup Wizard showing the initial page of a setup form](nextjs-setup-wizard.png)
40+
41+
Through the [setup wizard](https://nextjs-wizard.netlify.app/), you can create your blog in a few clicks and deploy to Netlify.
42+
43+
## Configuring the blog
44+
45+
The config is based on environment variables to make it easy to integrate with any Jamstack platform, like Netlify.
1046

1147
Here are the variables you can edit:
1248

nextjs-blog-theme-preview.png

306 KB
Loading

nextjs-setup-wizard.png

381 KB
Loading

0 commit comments

Comments
 (0)