Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
timlrx committed Feb 14, 2021
1 parent e91e693 commit 4f39ec0
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ I wanted it to be nearly as feature-rich as popular blogging templates like [bea
- Automatic image optimization via [next/image](https://nextjs.org/docs/basic-features/image-optimization)
- Flexible data retrieval with [next-mdx-remote](https://github.com/hashicorp/next-mdx-remote)
- Support for tags - each unique tag will be its own page
- Projects page
- SEO friendly with RSS feed, sitemaps and more!

## Sample posts
Expand All @@ -45,8 +46,11 @@ I wanted it to be nearly as feature-rich as popular blogging templates like [bea

1. Fork this project
2. Rename the project to <yourusername>.github.io
3. Modify `siteMetadata.json` and blog posts
4. Deploy on Vercel
3. Personalize `siteMetadata.json`
4. Modify `projectsData.js`
5. Modify `headerNavLinks.js` to customize navigation links
6. Add blog posts
7. Deploy on Vercel

## Development

Expand All @@ -66,6 +70,10 @@ You can start editing the page by modifying `pages/index.js`. The page auto-upda

`data/siteMetadata.json` - contains most of the site related information which should be modified for a user's need.

`data/projectsData.js` - data used to generate styled card in projects page.

`data/headerNavLinks.js` - navigation links.

`data/logo.svg` - replace with your own logo.

`data/blog` - replace with your own blog posts.
Expand Down
13 changes: 10 additions & 3 deletions data/blog/introducing-tailwind-nextjs-starter-blog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,12 @@ I wanted it to be nearly as feature-rich as popular blogging templates like [bea
## Quick Start Guide

1. Fork this project
2. Rename the project to `<yourusername>.github.io`
3. Modify `siteMetadata.json` and blog posts
4. Deploy on Vercel
2. Rename the project to <yourusername>.github.io
3. Personalize `siteMetadata.json`
4. Modify `projectsData.js`
5. Modify `headerNavLinks.js` to customize navigation links
6. Add blog posts
7. Deploy on Vercel

## Development

Expand All @@ -74,6 +77,10 @@ You can start editing the page by modifying `pages/index.js`. The page auto-upda

`data/siteMetadata.json` - contains most of the site related information which should be modified for a user's need.

`data/projectsData.js` - data used to generate styled card in projects page.

`data/headerNavLinks.js` - navigation links.

`data/logo.svg` - replace with your own logo.

`data/blog` - replace with your own blog posts.
Expand Down

0 comments on commit 4f39ec0

Please sign in to comment.