docs: update readme
This commit is contained in:
		
							
								
								
									
										21
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										21
									
								
								README.md
									
									
									
									
									
								
							| @@ -10,6 +10,8 @@ | ||||
|  | ||||
| This is a [Next.js](https://nextjs.org/), [Tailwind CSS](https://tailwindcss.com/) blogging starter template. Comes out of the box configured with the latest technologies to make technical writing a breeze. Easily configurable and customizable. Perfect as a replacement to existing Jekyll and Hugo individual blogs. | ||||
|  | ||||
| Check out the documentation below to get started. Facing issues? Checkout of the [FAQ page](https://github.com/timlrx/tailwind-nextjs-starter-blog/wiki) and do a search on past issues. Feel free to open a new issue if none has been posted previously. | ||||
|  | ||||
| ## Examples | ||||
|  | ||||
| - [Demo Blog](https://tailwind-nextjs-starter-blog.vercel.app/) - this repo | ||||
| @@ -38,6 +40,8 @@ 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 | ||||
| - Support for multiple authors | ||||
| - Blog templates | ||||
| - Support for nested routing of blog posts | ||||
| - Projects page | ||||
| - SEO friendly with RSS feed, sitemaps and more! | ||||
| @@ -54,11 +58,12 @@ I wanted it to be nearly as feature-rich as popular blogging templates like [bea | ||||
| ## Quick Start Guide | ||||
|  | ||||
| 1. `npx degit https://github.com/timlrx/tailwind-nextjs-starter-blog.git` | ||||
| 2. Personalize `siteMetadata.json` | ||||
| 3. Modify `projectsData.js` | ||||
| 4. Modify `headerNavLinks.js` to customize navigation links | ||||
| 5. Add blog posts | ||||
| 6. Deploy on Vercel | ||||
| 2. Personalize `siteMetadata.json` (site related information) | ||||
| 3. Personalize `authors/default.md` (main author) | ||||
| 4. Modify `projectsData.js` | ||||
| 5. Modify `headerNavLinks.js` to customize navigation links | ||||
| 6. Add blog posts | ||||
| 7. Deploy on Vercel | ||||
|  | ||||
| ## Development | ||||
|  | ||||
| @@ -78,6 +83,8 @@ 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/authors/default.md` - default author information (required). Additional authors can be added as files in `data/authors`. | ||||
|  | ||||
| `data/projectsData.js` - data used to generate styled card in projects page. | ||||
|  | ||||
| `data/headerNavLinks.js` - navigation links. | ||||
| @@ -114,6 +121,8 @@ lastmod (optional) | ||||
| draft (optional) | ||||
| summary (optional) | ||||
| images (optional, if none provided defaults to socialBanner in siteMetadata config) | ||||
| authors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified) | ||||
| layout (optional list which should correspond to the file names in `data/layouts`) | ||||
| ``` | ||||
|  | ||||
| Here's an example of a post's frontmatter: | ||||
| @@ -127,6 +136,8 @@ tags: ['next-js', 'tailwind', 'guide'] | ||||
| draft: false | ||||
| summary: 'Looking for a performant, out of the box template, with all the best in web technology to support your blogging needs? Checkout the Tailwind Nextjs Starter Blog template.' | ||||
| images: ['/static/images/canada/mountains.jpg', '/static/images/canada/toronto.jpg'] | ||||
| authors: ['default', 'sparrowhawk'] | ||||
| layout: PostLayout | ||||
| --- | ||||
| ``` | ||||
|  | ||||
|   | ||||
| @@ -1,7 +1,7 @@ | ||||
| --- | ||||
| title: 'Introducing Tailwind Nexjs Starter Blog' | ||||
| date: '2021-01-12' | ||||
| lastmod: '2021-05-08' | ||||
| lastmod: '2021-06-09' | ||||
| tags: ['next-js', 'tailwind', 'guide'] | ||||
| draft: false | ||||
| summary: 'Looking for a performant, out of the box template, with all the best in web technology to support your blogging needs? Checkout the Tailwind Nextjs Starter Blog template.' | ||||
| @@ -45,6 +45,8 @@ 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 | ||||
| - Support for multiple authors | ||||
| - Blog templates | ||||
| - Support for nested routing of blog posts | ||||
| - SEO friendly with RSS feed, sitemaps and more! | ||||
|  | ||||
| @@ -60,11 +62,12 @@ I wanted it to be nearly as feature-rich as popular blogging templates like [bea | ||||
| ## Quick Start Guide | ||||
|  | ||||
| 1. `npx degit https://github.com/timlrx/tailwind-nextjs-starter-blog.git` | ||||
| 2. Personalize `siteMetadata.json` | ||||
| 3. Modify `projectsData.js` | ||||
| 4. Modify `headerNavLinks.js` to customize navigation links | ||||
| 5. Add blog posts | ||||
| 6. Deploy on Vercel | ||||
| 2. Personalize `siteMetadata.json` (site related information) | ||||
| 3. Personalize `authors/default.md` (main author) | ||||
| 4. Modify `projectsData.js` | ||||
| 5. Modify `headerNavLinks.js` to customize navigation links | ||||
| 6. Add blog posts | ||||
| 7. Deploy on Vercel | ||||
|  | ||||
| ## Development | ||||
|  | ||||
| @@ -84,6 +87,8 @@ 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/authors/default.md` - default author information (required). Additional authors can be added as files in `data/authors`. | ||||
|  | ||||
| `data/projectsData.js` - data used to generate styled card in projects page. | ||||
|  | ||||
| `data/headerNavLinks.js` - navigation links. | ||||
| @@ -120,6 +125,8 @@ lastmod (optional) | ||||
| draft (optional) | ||||
| summary (optional) | ||||
| images (optional, if none provided defaults to socialBanner in siteMetadata config) | ||||
| authors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified) | ||||
| layout (optional list which should correspond to the file names in `data/layouts`) | ||||
| ``` | ||||
|  | ||||
| Here's an example of a post's frontmatter: | ||||
| @@ -133,6 +140,8 @@ tags: ['next-js', 'tailwind', 'guide'] | ||||
| draft: false | ||||
| summary: 'Looking for a performant, out of the box template, with all the best in web technology to support your blogging needs? Checkout the Tailwind Nextjs Starter Blog template.' | ||||
| images: ['/static/images/canada/mountains.jpg', '/static/images/canada/toronto.jpg'] | ||||
| authors: ['default', 'sparrowhawk'] | ||||
| layout: PostLayout | ||||
| --- | ||||
| ``` | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user