https://github.com/tinalabs/next-git-starter

https://github.com/tinalabs/next-git-starter

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tinalabs/next-git-starter
• Owner: tinalabs
• Created: 2021-05-11T00:52:35.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-17T12:05:47.000Z (over 3 years ago)
• Last Synced: 2023-03-10T08:39:12.324Z (over 1 year ago)
• Language: JavaScript
• Size: 328 KB
• Stars: 1
• Watchers: 3
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**A clone of the Next.js [blog starter](https://github.com/vercel/next.js/tree/canary/examples/blog-starter) to make it easier to fork & import to [Tina Cloud](https://tina.io/cloud/)**. 🦙

![next-blog-starter-tina-cloud](https://user-images.githubusercontent.com/103008/118156607-d83d2500-b419-11eb-9aa9-59d531a26987.png)

# A statically generated blog example using Next.js and Markdown

This example showcases Next.js's [Static Generation](https://nextjs.org/docs/basic-features/pages) feature using Markdown files as the data source.

The blog posts are stored in `/_posts` as Markdown files with front matter support. Adding a new Markdown file in there will create a new blog post.

To create the blog posts we use [`remark`](https://github.com/remarkjs/remark) and [`remark-html`](https://github.com/remarkjs/remark-html) to convert the Markdown files into an HTML string, and then send it down as a prop to the page. The metadata of every post is handled by [`gray-matter`](https://github.com/jonschlinkert/gray-matter) and also sent in props to the page.

## Demo

[https://next-blog-starter.vercel.app/](https://next-blog-starter.vercel.app/)

## Deploy your own

Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/blog-starter&project-name=blog-starter&repository-name=blog-starter)

## How to use

Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:

```bash

npx create-next-app --example blog-starter blog-starter-app

# or

yarn create next-app --example blog-starter blog-starter-app

```

Your blog should be up and running on [http://localhost:3000](http://localhost:3000)! If it doesn't work, post on [GitHub discussions](https://github.com/vercel/next.js/discussions).

Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).

# Notes

This blog-starter uses [Tailwind CSS](https://tailwindcss.com). To control the generated stylesheet's filesize, this example uses Tailwind CSS' v2.0 [`purge` option](https://tailwindcss.com/docs/controlling-file-size/#removing-unused-css) to remove unused CSS.