{"id":16498388,"url":"https://github.com/geekskai/blog","last_synced_at":"2025-03-16T18:32:26.423Z","repository":{"id":113251205,"uuid":"167761702","full_name":"geekskai/blog","owner":"geekskai","description":"只要写markdown就行，轻松简单搭建属于自己的个人博客，无需框架，直接fork仓库，改成自己的内容就能用，简单轻松一键部署，支持自定义域名和评论功能！","archived":false,"fork":false,"pushed_at":"2024-10-30T02:16:46.000Z","size":79708,"stargazers_count":30,"open_issues_count":0,"forks_count":17,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-10-30T03:58:18.316Z","etag":null,"topics":["blog","blog-template","blog-theme","github-pages","nextjs","nextjs-blog","nextjs-template","nextjs14","reactjs","tainwindcss"],"latest_commit_sha":null,"homepage":"https://geekskai.com/","language":"MDX","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/geekskai.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"geekskai"}},"created_at":"2019-01-27T02:33:21.000Z","updated_at":"2024-10-30T02:16:50.000Z","dependencies_parsed_at":"2024-11-10T15:35:06.572Z","dependency_job_id":null,"html_url":"https://github.com/geekskai/blog","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekskai%2Fblog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekskai%2Fblog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekskai%2Fblog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekskai%2Fblog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geekskai","download_url":"https://codeload.github.com/geekskai/blog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826783,"owners_count":20354220,"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","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":["blog","blog-template","blog-theme","github-pages","nextjs","nextjs-blog","nextjs-template","nextjs14","reactjs","tainwindcss"],"created_at":"2024-10-11T14:48:19.383Z","updated_at":"2025-03-16T18:32:21.404Z","avatar_url":"https://github.com/geekskai.png","language":"MDX","readme":"![geekskai-blog](/public/static/images/geekskai-blog.png)\n![geekskai-blog-detail-mobile](/public/static/images/geekskai-blog-detail-mobile.png)\n![geekskai-blog-list](/public/static/images/geekskai-blog-list.png)\n![geekskai-readme-blog](/public/static/images/readme-blog.png)\n![geekskai-blog-performance](/public/static/images/performance.png)\n\n[https://www.geekskai.com/](https://www.geekskai.com/)\n\n# Tailwind Nextjs Blog\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/geekskai/blog)\n\nThis is a [Next.js](https://nextjs.org/), [Tailwind CSS](https://tailwindcss.com/) blogging 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/geekskai/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## 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, Emailoctopus and Beehiiv\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- [Github alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) via [remark-github-blockquote-alert](https://github.com/jaywcjlove/remark-github-blockquote-alert)\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## Quick Start Guide\n\n1. Clone the repo\n\n```bash\nnpx degit 'geekskai/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.ts`\n6. Modify `headerNavLinks.ts` to customize navigation links\n7. Add blog posts\n8. Deploy on Vercel\n\n## Installation\n\n```bash\nyarn\n```\n\nPlease note, that if you are using Windows, you may need to run:\n\n```bash\n$env:PWD = $(Get-Location).Path\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### Front matter\n\nFront matter 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  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  Blog template.'\nimages: ['/static/images/canada/mountains.jpg', '/static/images/canada/toronto.jpg']\nauthors: ['default', 'sparrowhawk']\nlayout: PostLayout\ncanonicalUrl: https://geekskai.com/blog/js/how-to-remove-milliseconds-from-timestamp-in-js/\n---\n```\n\n## Deploy\n\n### GitHub Pages\n\nA [`pages.yml`](.github/workflows/pages.yml) workflow is already provided. Simply select \"GitHub Actions\" in: `Settings \u003e Pages \u003e Build and deployment \u003e Source`.\n\n### Vercel\n\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\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\nRun:\n\n```sh\n$ EXPORT=1 UNOPTIMIZED=1 yarn build\n```\n\nThen, deploy the generated `out` folder or run `npx serve out` it locally.\n\n\u003e [!IMPORTANT]\n\u003e If deploying with a URL base path, like https://example.org/myblog you need an extra `BASE_PATH` shell-var to the build command:\n\u003e\n\u003e ```sh\n\u003e $ EXPORT=1 UNOPTIMIZED=1 BASE_PATH=/myblog yarn build\n\u003e ```\n\u003e\n\u003e =\u003e In your code, `${process.env.BASE_PATH || ''}/robots.txt` will print `\"/myblog/robots.txt\"` in the `out` build (or only `/robots.txt` if `yarn dev`, ie: on localhost:3000)\n\n\u003e [!TIP]\n\u003e Alternatively to `UNOPTIMIZED=1`, 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\nConsider removing the following features that cannot be used in a static build:\n\n1. Comment out `headers()` from `next.config.js`.\n2. 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.\n\n## Frequently Asked Questions\n\n- [How can I add a custom MDX component?](/faq/custom-mdx-component.md)\n- [How can I customize the `kbar` search?](/faq/customize-kbar-search.md)\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/geekskai).\n\n## Licence\n\n[MIT](https://github.com/geekskai/blog/blob/main/LICENSE) © [geeks kai](https://www.geekskai.com)\n","funding_links":["https://github.com/sponsors/geekskai"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeekskai%2Fblog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeekskai%2Fblog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeekskai%2Fblog/lists"}