docs: update readme

This commit is contained in:
Timothy Lin
2021-02-14 19:16:14 +08:00
parent e91e6935c2
commit 4f39ec0e04
2 changed files with 20 additions and 5 deletions

View File

@ -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
@ -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.