Tie knowledge by writing it
I believe noting down and sharing is the best way to learn! So I created this blog, where I keep things that I learned, find useful, and necessary to save for later.
More than just technical stuff, there are personal thoughts about work and life from the perspective of a software engineer.
It would be highly appreciated if I could read your comment on what I wrote
This blog is hosted on Vercel, built with Next.js (Preact for production) and Tailwind CSS using Tailwind Nextjs Starter Blog.
A huge thanks to Timothy Lin for the minimal, lightweight, and super easy-to-customize blog starter.
And thanks to Tuan Anh (Leo) Huynh for the blog template inspiration.
All images in this blog are from Unsplash, imgur and GIPHY - Thanks for the free resources!
- TypeScript and Contentlayer (alpha)
npx degit 'timlrx/tailwind-nextjs-starter-blog#contentlayer'
or JS (official support)
npx degit https://github.com/timlrx/tailwind-nextjs-starter-blog.git
or with TypeScript (community support)
npx degit 'timlrx/tailwind-nextjs-starter-blog#typescript'
- Personalize
siteMetadata.js
(site related information) - Modify the content security policy in
next.config.js
if you want to use any analytics provider or a commenting solution other than giscus. - Personalize
authors/default.md
(main author) - Modify
projectsData.js
- Modify
headerNavLinks.js
to customize navigation links - Add blog posts
- Deploy on Vercel
npm install
First, run the development server:
npm start
or
npm run dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.js
. The page auto-updates as you edit the file.
data/siteMetadata.js
- 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 on the projects page.
data/headerNavLinks.js
- navigation links.
data/logo.svg
- replace with your own logo.
data/blog
- replace with your own blog posts.
public/static
- store assets such as images and favicons.
tailwind.config.js
and css/tailwind.css
- contain the tailwind stylesheet which can be modified to change the overall look and feel of the site.
css/prism.css
- controls the styles associated with the code blocks. Feel free to customize it and use your preferred prismjs theme e.g. prism themes.
components/social-icons
- to add other icons, simply copy an svg file from Simple Icons and map them in index.js
. Other icons use heroicons.
components/MDXComponents.js
- pass your own JSX code or React component by specifying it over here. You can then call them directly in the .mdx
or .md
file. By default, a custom link and image component is passed.
layouts
- main templates used in pages.
pages
- pages to route to. Read the Next.js documentation for more information.
next.config.js
- configuration related to Next.js. You need to adapt the Content Security Policy if you want to load scripts, images etc. from other domains.
Frontmatter follows Hugo's standards.
Currently 7 fields are supported.
title (required)
date (required)
tags (required, can be empty array)
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`)
canonicalUrl (optional, canonical url for the post for SEO)
Here's an example of a post's frontmatter:
---
title: 'Introducing Tailwind Nexjs Starter Blog'
date: '2021-01-12'
lastmod: '2021-01-18'
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
canonicalUrl: https://tailwind-nextjs-starter-blog.vercel.app/blog/introducing-tailwind-nextjs-starter-blog
---
Run node ./scripts/compose.js
to bootstrap a new post.
Follow the interactive prompt to generate a post with pre-filled front matter.
Copyright (c) 2022 Muhammad Iqbal (Iqbal) - Alrights reserved.