{"id":15829725,"url":"https://github.com/hellofaizan/blog","last_synced_at":"2025-08-01T06:10:05.545Z","repository":{"id":191777296,"uuid":"685370758","full_name":"hellofaizan/blog","owner":"hellofaizan","description":"Ahh! Every shit that comes into my mind will be marked down here","archived":false,"fork":false,"pushed_at":"2023-08-31T05:00:09.000Z","size":1752,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-12T11:08:41.373Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://blog-plum-xi-62.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hellofaizan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"timlrx"}},"created_at":"2023-08-31T04:44:23.000Z","updated_at":"2023-08-31T04:46:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"5be7f00f-f8a0-4266-b917-509857f32a4d","html_url":"https://github.com/hellofaizan/blog","commit_stats":{"total_commits":3,"total_committers":2,"mean_commits":1.5,"dds":"0.33333333333333337","last_synced_commit":"58f9efd10e72fb84ff79dc5faeebc7c395a98d98"},"previous_names":["hellofaizan/blog"],"tags_count":0,"template":false,"template_full_name":"hellofaizan/tailwind-nextjs-starter-blog","purl":"pkg:github/hellofaizan/blog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellofaizan%2Fblog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellofaizan%2Fblog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellofaizan%2Fblog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellofaizan%2Fblog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hellofaizan","download_url":"https://codeload.github.com/hellofaizan/blog/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hellofaizan%2Fblog/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266342809,"owners_count":23914262,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-05T11:02:23.669Z","updated_at":"2025-07-21T17:32:55.659Z","avatar_url":"https://github.com/hellofaizan.png","language":"TypeScript","funding_links":["https://github.com/sponsors/timlrx","https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026link=https://github.com/sponsors/timlrx"],"categories":[],"sub_categories":[],"readme":"![tailwind-nextjs-banner](/public/static/images/twitter-card.png)\n\n# Tailwind Nextjs Starter Blog\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/timlrx/tailwind-nextjs-starter-blog?style=social)](https://GitHub.com/timlrx/tailwind-nextjs-starter-blog/stargazers/)\n[![GitHub forks](https://img.shields.io/github/forks/timlrx/tailwind-nextjs-starter-blog?style=social)](https://GitHub.com/timlrx/tailwind-nextjs-starter-blog/network/)\n[![Twitter URL](https://img.shields.io/twitter/url?style=social\u0026url=https%3A%2F%2Ftwitter.com%2Ftimlrxx)](https://twitter.com/timlrxx)\n[![Sponsor](https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026link=https://github.com/sponsors/timlrx)](https://github.com/sponsors/timlrx)\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/timlrx/tailwind-nextjs-starter-blog)\n\nThis is a [Next.js](https://nextjs.org/), [Tailwind CSS](https://tailwindcss.com/) blogging starter template. Version 2 is based on Next App directory with [React Server Component](https://nextjs.org/docs/getting-started/react-essentials#server-components) and uses [Contentlayer](https://www.contentlayer.dev/) to manage markdown content.\n\nProbably the most feature-rich Next.js markdown blogging template out there. Easily configurable and customizable. Perfect as a replacement to existing Jekyll and Hugo individual blogs.\n\nCheck out the documentation below to get started.\n\nFacing issues? Check 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.\n\nFeature request? Check the past discussions to see if it has been brought up previously. Otherwise, feel free to start a new discussion thread. All ideas are welcomed!\n\n## Examples V2\n\n- [Demo Blog](https://tailwind-nextjs-starter-blog.vercel.app/) - this repo\n- [My personal blog](https://www.timlrx.com) - modified to auto-generate blog posts with dates\n- [ben.codes blog](https://ben.codes) - Benoit's personal blog about software development ([source code](https://github.com/bendotcodes/bendotcodes))\n- [tsix blog](https://tsix.top) - A front-end engineer is used to record some knowledge points in work and study _中文_\n- [SOTO's Blog](https://www.atksoto.com/) - A more personalized personal website upgraded from V1 ([source code](https://github.com/acsoto/soto-blog-nextjs))\n- [Prabhu's Blog](https://prabhukirankonda.vercel.app) - Prabhu's Personal website with blog ([source code](https://github.com/prabhukiran8790/prabhukirankonda))\n\nUsing the template? Feel free to create a PR and add your blog to this list.\n\n## Examples V1\n\n[v1-blogs-showcase.webm](https://github.com/timlrx/tailwind-nextjs-starter-blog/assets/28362229/2124c81f-b99d-4431-839c-347e01a2616c)\n\nThanks to the community of users and contributors to the template! We are no longer accepting new blog listings over here. If you have updated from version 1 to version 2, feel free to remove your blog from this list and add it to the one above.\n\n- [Aloisdg's cookbook](https://tambouille.vercel.app/) - with pictures and recipes!\n- [GautierArcin's demo with next translate](https://tailwind-nextjs-starter-blog-seven.vercel.app/) - includes translation of mdx posts, [source code](https://github.com/GautierArcin/tailwind-nextjs-starter-blog/tree/demo/next-translate)\n- [David Levai's digital garden](https://davidlevai.com/) - customized design and added email subscriptions\n- [Leo's Blog](https://leohuynh.dev) - Tuan Anh Huynh's personal site. Add Snippets Page, Author Profile Card, Image Lightbox, ...\n- [thvu.dev](https://thvu.dev) - Added `mdx-embed`, view count, reading minutes and more.\n- [irvin.dev](https://www.irvin.dev/) - Irvin Lin's personal site. Added YouTube embedding.\n- [KirillSo.com](https://www.kirillso.com/) - Personal blog \u0026 website.\n- [slightlysharpe.com](https://slightlysharpe.com) - [Tincre's](https://tincre.com) main company blog\n- [blog.b00st.com](https://blog.b00st.com) - [b00st.com's](https://b00st.com) main music promotion blog\n- [astrosaurus.me](https://astrosaurus.me/) - Ephraim Atta-Duncan's Personal Blog\n- [dhanrajsp.me](https://dhanrajsp.me/) - Dhanraj's personal site and blog.\n- [blog.r00ks.io](https://blog.r00ks.io/) - Austin Rooks's personal blog ([source code](https://github.com/Austionian/blog.r00ks)).\n- [honghong.me](https://honghong.me) - Tszhong's personal website ([source code](https://github.com/tszhong0411/home))\n- [marceloformentao.dev](https://marceloformentao.dev) - Marcelo Formentão personal website ([source code](https://github.com/marceloavf/marceloformentao.dev)).\n- [abiraja.com](https://www.abiraja.com/) - with a [runnable JS code snippet component!](https://www.abiraja.com/blog/querying-solana-blockchain)\n- [bpiggin.com](https://www.bpiggin.com) - Ben Piggin's personal blog\n- [maqib.cn](https://maqib.cn) - A blog of Chinese front-end developers 狂奔小马的博客 ([源码](https://github.com/maqi1520/nextjs-tailwind-blog))\n- [ambilena.com](https://ambilena.com/) - Electronic Music Blog \u0026 imprint for upcoming musicians.\n- [dalelarroder.com](https://dalelarroder.com) - Dale Larroder's personal website and blog ([source code](https://github.com/dlarroder/dalelarroder))\n- [0xchai.io](https://0xchai.io) - Chai's personal blog\n- [techipedia](https://techipedia.vercel.app) - Simple blogging progressive web app with custom installation button and top progress bar\n- [reubence.com](https://reubence.com) - Reuben Rapose's Digital Garden\n- [axolo.co/blog](https://axolo.co/blog) - Engineering management news \u0026 axolo.co updates (with image preview for article in the home page)\n- [musing.vercel.app](https://musing.vercel.app/) - Parth Desai's personal blog ([source code](https://github.com/pycoder2000/blog))\n- [onyourmental.com](https://www.onyourmental.com/) - [Curtis Warcup's](https://github.com/Cwarcup) website for the On Your Mental Podcast ([source code](https://github.com/Cwarcup/on-your-mental))\n- [cwarcup.com](https://www.cwarcup.com/) - Curtis Warcup's personal website and blog ([source code](https://github.com/Cwarcup/personal-blog)).\n- [ondiek-elijah.me](https://www.ondiek-elijah.me/) - Ondiek Elijah's website and blog ([source code](https://github.com/Dev-Elie/ondiek-elijah)).\n- [jmalvarez.dev](https://www.jmalvarez.dev/) - José Miguel Álvarez's personal blog ([source code](https://github.com/josemiguel-alvarez/nextjs-blog))\n- [justingosses.com](https://justingosses.com/) - Justin Gosses's personal website and blog ([source code](https://github.com/JustinGOSSES/justingosses-website))\n- [https://bitoflearning-9a57.fly.dev/](https://bitoflearning-9a57.fly.dev/) - Sangeet Agarwal's personal blog, replatformed to [remix](https://remix.run/remix) using the [indie stack](https://github.com/remix-run/indie-stack) ([source code](https://github.com/SangeetAgarwal/bitoflearning))\n- [raphaelchelly.com](https://www.raphaelchelly.com/) - Raphaël Chelly's personal website and blog ([source code](https://github.com/raphaelchelly/raph_www))\n- [kaveh.page](https://kaveh.page) - Kaveh Tehrani's personal blog. Added tags directory, profile card, time-to-read on posts directory, etc.\n\n## Motivation\n\nI wanted to port my existing blog to Nextjs and Tailwind CSS but there was no easy out of the box template to use so I decided to create one. Design is adapted from [Tailwindlabs blog](https://github.com/tailwindlabs/blog.tailwindcss.com).\n\nI wanted it to be nearly as feature-rich as popular blogging templates like [beautiful-jekyll](https://github.com/daattali/beautiful-jekyll) and [Hugo Academic](https://github.com/wowchemy/wowchemy-hugo-modules) but with the best of React's ecosystem and current web development's best practices.\n\n## Features\n\n- Next.js with Typescript\n- [Contentlayer](https://www.contentlayer.dev/) to manage content logic\n- Easy styling customization with [Tailwind 3.0](https://tailwindcss.com/blog/tailwindcss-v3) and primary color attribute\n- [MDX - write JSX in markdown documents!](https://mdxjs.com/)\n- Near perfect lighthouse score - [Lighthouse report](https://www.webpagetest.org/result/230805_BiDcBQ_4H7)\n- Lightweight, 85kB first load JS\n- Mobile-friendly view\n- Light and dark theme\n- Font optimization with [next/font](https://nextjs.org/docs/app/api-reference/components/font)\n- Integration with [pliny](https://github.com/timlrx/pliny) that provides:\n  - Multiple analytics options including [Umami](https://umami.is/), [Plausible](https://plausible.io/), [Simple Analytics](https://simpleanalytics.com/), Posthog and Google Analytics\n  - Comments via [Giscus](https://github.com/laymonage/giscus), [Utterances](https://github.com/utterance/utterances) or Disqus\n  - Newsletter API and component with support for Mailchimp, Buttondown, Convertkit, Klaviyo, Revue, and Emailoctopus\n  - Command palette search with [Kbar](https://github.com/timc1/kbar) or Algolia\n- Server-side syntax highlighting with line numbers and line highlighting via [rehype-prism-plus](https://github.com/timlrx/rehype-prism-plus)\n- Math display supported via [KaTeX](https://katex.org/)\n- Citation and bibliography support via [rehype-citation](https://github.com/timlrx/rehype-citation)\n- Automatic image optimization via [next/image](https://nextjs.org/docs/basic-features/image-optimization)\n- Support for tags - each unique tag will be its own page\n- Support for multiple authors\n- 3 different blog layouts\n- 2 different blog listing layouts\n- Support for nested routing of blog posts\n- Projects page\n- Preconfigured security headers\n- SEO friendly with RSS feed, sitemaps and more!\n\n## Sample posts\n\n- [A markdown guide](https://tailwind-nextjs-starter-blog.vercel.app/blog/github-markdown-guide)\n- [Learn more about images in Next.js](https://tailwind-nextjs-starter-blog.vercel.app/blog/guide-to-using-images-in-nextjs)\n- [A tour of math typesetting](https://tailwind-nextjs-starter-blog.vercel.app/blog/deriving-ols-estimator)\n- [Simple MDX image grid](https://tailwind-nextjs-starter-blog.vercel.app/blog/pictures-of-canada)\n- [Example of long prose](https://tailwind-nextjs-starter-blog.vercel.app/blog/the-time-machine)\n- [Example of Nested Route Post](https://tailwind-nextjs-starter-blog.vercel.app/blog/nested-route/introducing-multi-part-posts-with-nested-routing)\n\n## Quick Start Guide\n\n1. Clone the repo\n\n```bash\nnpx degit 'timlrx/tailwind-nextjs-starter-blog'\n```\n\n2. Personalize `siteMetadata.js` (site related information)\n3. Modify the content security policy in `next.config.js` if you want to use\n   other analytics provider or a commenting solution other than giscus.\n4. Personalize `authors/default.md` (main author)\n5. Modify `projectsData.js`\n6. Modify `headerNavLinks.js` to customize navigation links\n7. Add blog posts\n8. Deploy on Vercel\n\n## Installation\n\n```bash\nyarn\n```\n\n## Development\n\nFirst, run the development server:\n\n```bash\nyarn dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the result.\n\nEdit the layout in `app` or content in `data`. With live reloading, the pages auto-updates as you edit them.\n\n## Extend / Customize\n\n`data/siteMetadata.js` - contains most of the site related information which should be modified for a user's need.\n\n`data/authors/default.md` - default author information (required). Additional authors can be added as files in `data/authors`.\n\n`data/projectsData.js` - data used to generate styled card on the projects page.\n\n`data/headerNavLinks.js` - navigation links.\n\n`data/logo.svg` - replace with your own logo.\n\n`data/blog` - replace with your own blog posts.\n\n`public/static` - store assets such as images and favicons.\n\n`tailwind.config.js` and `css/tailwind.css` - tailwind configuration and stylesheet which can be modified to change the overall look and feel of the site.\n\n`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](https://github.com/PrismJS/prism-themes).\n\n`contentlayer.config.ts` - configuration for Contentlayer, including definition of content sources and MDX plugins used. See [Contentlayer documentation](https://www.contentlayer.dev/docs/getting-started) for more information.\n\n`components/MDXComponents.js` - pass your own JSX code or React component by specifying it over here. You can then use them directly in the `.mdx` or `.md` file. By default, a custom link, `next/image` component, table of contents component and Newsletter form are passed down. Note that the components should be default exported to avoid [existing issues with Next.js](https://github.com/vercel/next.js/issues/51593).\n\n`layouts` - main templates used in pages:\n\n- There are currently 3 post layouts available: `PostLayout`, `PostSimple` and `PostBanner`. `PostLayout` is the default 2 column layout with meta and author information. `PostSimple` is a simplified version of `PostLayout`, while `PostBanner` features a banner image.\n- There are 2 blog listing layouts: `ListLayout`, the layout used in version 1 of the template with a search bar and `ListLayoutWithTags`, currently used in version 2, which omits the search bar but includes a sidebar with information on the tags.\n\n`app` - pages to route to. Read the [Next.js documentation](https://nextjs.org/docs/app) for more information.\n\n`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.\n\n## Post\n\nContent is modelled using [Contentlayer](https://www.contentlayer.dev/), which allows you to define your own content schema and use it to generate typed content objects. See [Contentlayer documentation](https://www.contentlayer.dev/docs/getting-started) for more information.\n\n### Frontmatter\n\nFrontmatter follows [Hugo's standards](https://gohugo.io/content-management/front-matter/).\n\nPlease refer to `contentlayer.config.ts` for an up to date list of supported fields. The following fields are supported:\n\n```\ntitle (required)\ndate (required)\ntags (optional)\nlastmod (optional)\ndraft (optional)\nsummary (optional)\nimages (optional)\nauthors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified)\nlayout (optional list which should correspond to the file names in `data/layouts`)\ncanonicalUrl (optional, canonical url for the post for SEO)\n```\n\nHere's an example of a post's frontmatter:\n\n```\n---\ntitle: 'Introducing Tailwind Nexjs Starter Blog'\ndate: '2021-01-12'\nlastmod: '2021-01-18'\ntags: ['next-js', 'tailwind', 'guide']\ndraft: false\nsummary: '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.'\nimages: ['/static/images/canada/mountains.jpg', '/static/images/canada/toronto.jpg']\nauthors: ['default', 'sparrowhawk']\nlayout: PostLayout\ncanonicalUrl: https://tailwind-nextjs-starter-blog.vercel.app/blog/introducing-tailwind-nextjs-starter-blog\n---\n```\n\n## Deploy\n\n**Vercel**  \nThe easiest way to deploy the template is to deploy on [Vercel](https://vercel.com). Check out the [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.\n\n**Netlify**\n[Netlify](https://www.netlify.com/)’s Next.js runtime configures enables key Next.js functionality on your website without the need for additional configurations. Netlify generates serverless functions that will handle Next.js functionalities such as server-side rendered (SSR) pages, incremental static regeneration (ISR), `next/images`, etc.\n\nSee [Next.js on Netlify](https://docs.netlify.com/integrations/frameworks/next-js/overview/#next-js-runtime) for suggested configuration values and more details.\n\n**Static hosting services / GitHub Pages / S3 / Firebase etc.**\n\n1. Add `output: 'export'` in `next.config.js`. See [static exports documentation](https://nextjs.org/docs/app/building-your-application/deploying/static-exports#configuration) for more information.\n2. Comment out `headers()` from `next.config.js`.\n3. Change `components/Image.tsx` to use a standard `\u003cimg\u003e` tag instead of `next/image`:\n\n   ```ts\n   /* eslint-disable jsx-a11y/alt-text */\n   /* eslint-disable @next/next/no-img-element */\n   import NextImage, { ImageProps } from 'next/image'\n\n   // @ts-ignore\n   const Image = ({ ...rest }: ImageProps) =\u003e \u003cimg {...rest} /\u003e\n\n   export default Image\n   ```\n\n   Alternatively, to continue using `next/image`, you can use an alternative image optimization provider such as Imgix, Cloudinary or Akamai. See [image optimization documentation](https://nextjs.org/docs/app/building-your-application/deploying/static-exports#image-optimization) for more details.\n\n4. Remove `api` folder and components which call the server-side function such as the Newsletter component. Not technically required and the site will build successfully, but the APIs cannot be used as they are server-side functions.\n5. Run `yarn build`. The generated static content is in the `out` folder.\n6. Deploy the `out` folder to your hosting service of choice or run `npx serve out` to view the website locally.\n\n## Frequently Asked Questions\n\n### How can I customize the `kbar` search?\n\nAdd a `SearchProvider` component such as the one shown below and use it in place of the default `SearchProvider` component in `app/layout.tsx`.\n\n`defaultActions` are the initial list of actions.\n\n`onSearchDocumentsLoad` is a callback function that is called when the documents specified by `searchDocumentsPath` are loaded. Set `searchDocumentsPath` to `false` to disable the dynamically loaded search feature.\n\n```tsx\n'use client'\n\nimport { KBarSearchProvider } from 'pliny/search/KBar'\nimport { useRouter } from 'next/navigation'\nimport { CoreContent } from 'pliny/utils/contentlayer'\nimport { Blog } from 'contentlayer/generated'\n\nexport const SearchProvider = ({ children }) =\u003e {\n  const router = useRouter()\n  return (\n    \u003cKBarSearchProvider\n      kbarConfig={{\n        searchDocumentsPath: 'search.json',\n        defaultActions: [\n          {\n            id: 'homepage',\n            name: 'Homepage',\n            keywords: '',\n            shortcut: ['h', 'h'],\n            section: 'Home',\n            perform: () =\u003e router.push('/'),\n          },\n          {\n            id: 'projects',\n            name: 'Projects',\n            keywords: '',\n            shortcut: ['p'],\n            section: 'Home',\n            perform: () =\u003e router.push('/projects'),\n          },\n        ],\n        onSearchDocumentsLoad(json) {\n          return json.map((post: CoreContent\u003cBlog\u003e) =\u003e ({\n            id: post.path,\n            name: post.title,\n            keywords: post?.summary || '',\n            section: 'Blog',\n            subtitle: post.tags.join(', '),\n            perform: () =\u003e router.push(post.path),\n          }))\n        },\n      }}\n    \u003e\n      {children}\n    \u003c/KBarSearchProvider\u003e\n  )\n}\n```\n\n## Support\n\nUsing the template? Support this effort by giving a star on GitHub, sharing your own blog and giving a shoutout on Twitter or becoming a project [sponsor](https://github.com/sponsors/timlrx).\n\n## Licence\n\n[MIT](https://github.com/timlrx/tailwind-nextjs-starter-blog/blob/main/LICENSE) © [Timothy Lin](https://www.timlrx.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhellofaizan%2Fblog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhellofaizan%2Fblog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhellofaizan%2Fblog/lists"}