https://github.com/brob/next-search-index

https://github.com/brob/next-search-index

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/brob/next-search-index
• Owner: brob
• Created: 2021-07-23T18:31:29.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T17:36:52.000Z (about 1 year ago)
• Last Synced: 2024-11-07T00:29:52.993Z (2 months ago)
• Language: JavaScript
• Size: 315 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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.

## Preview

Preview the example live on [StackBlitz](http://stackblitz.com/):

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/blog-starter)

## 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)

### Related examples

- [WordPress](/examples/cms-wordpress)

- [DatoCMS](/examples/cms-datocms)

- [Sanity](/examples/cms-sanity)

- [TakeShape](/examples/cms-takeshape)

- [Prismic](/examples/cms-prismic)

- [Contentful](/examples/cms-contentful)

- [Strapi](/examples/cms-strapi)

- [Agility CMS](/examples/cms-agilitycms)

- [Cosmic](/examples/cms-cosmic)

- [ButterCMS](/examples/cms-buttercms)

- [Storyblok](/examples/cms-storyblok)

- [GraphCMS](/examples/cms-graphcms)

- [Kontent](/examples/cms-kontent)

## 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:

```

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.