From 4f39ec0e04932b0b1d2c0046a4bd062d683f8ff7 Mon Sep 17 00:00:00 2001 From: Timothy Lin Date: Sun, 14 Feb 2021 19:16:14 +0800 Subject: [PATCH] docs: update readme --- README.md | 12 ++++++++++-- .../introducing-tailwind-nextjs-starter-blog.mdx | 13 ++++++++++--- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e1d0343fc..9ae40fcee 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 .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 @@ -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. diff --git a/data/blog/introducing-tailwind-nextjs-starter-blog.mdx b/data/blog/introducing-tailwind-nextjs-starter-blog.mdx index 3d0cda1cf..373a30560 100644 --- a/data/blog/introducing-tailwind-nextjs-starter-blog.mdx +++ b/data/blog/introducing-tailwind-nextjs-starter-blog.mdx @@ -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 `.github.io` -3. Modify `siteMetadata.json` and blog posts -4. Deploy on Vercel +2. Rename the project to .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.