Skip to content

Commit bc91e45

Browse files
committed
feat: add README
1 parent bff7b12 commit bc91e45

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Next.js Blog Theme
2+
3+
A simple blog starter based on Next.js, Tailwind 3.0 and MDX support. Includes modern design with dark and light theme.
4+
5+
[Wizard](https://nextjs-wizard.netlify.app/) - create your own blog in few clicks and deploy on Netlify.
6+
7+
## Configure the blog
8+
9+
The config is based on ENV Variables to make it easy to integrate with any Jamstack platform like Netlify.
10+
11+
Here are the variables you can edit:
12+
13+
- `BLOG_NAME` - that's the name of your blog and will be displayed below the avatar.
14+
- `BLOG_TITLE` - the main header (`h1`) on the home page, this can be a slogan.
15+
- `BLOG_FOOTER_TEXT` - the text in the footer, usually copyright info.
16+
- `BLOG_THEME`
17+
- `BLOG_FONT_HEADINGS` - the font-family for all HTML headings, from `h1` to `h6`. The value can be one of those:
18+
- `sans-serif` (selected by default)
19+
- `serif`
20+
- `monospace`
21+
- `BLOG_FONT_PARAGRAPHS` - the font-family for all other HTML elements. The value can be one of those:
22+
- `sans-serif` (selected by default)
23+
- `serif`
24+
- `monospace`
25+
26+
All of the env variables can be configured through the [Wizard](https://nextjs-wizard.netlify.app/).
27+
28+
## Adding new posts
29+
30+
All posts are stored in `posts` directory in `.mdx` format. That means you can use React components there to make your posts more interactive.

0 commit comments

Comments
 (0)