Giter Club home page Giter Club logo

next-netlify-blog-starter's Introduction

Next + Netlify Markdown Blog Starter

Netlify Status

This is a lightweight Next.js (v9.5+) Markdown Blog, configured so you can one-click install a blog and deploy it to Netlify!

Get started by clicking here (this will clone the repo and deploy the site):

Deploy to Netlify

Or, if you'd like to build it yourself, here's a tutorial blog post that should get you on the right track!

The nitty gritty

If you'd like to work with this project locally, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

If you'd like to write a new blog post, write it in Markdown in the posts directory.

Installation options

Option one: One-click deploy

Deploy to Netlify

Option two: Manual clone

  1. Clone this repo: git clone https://github.com/cassidoo/next-netlify-blog-starter
  2. Navigate to the directory and run npm run dev
  3. Make your changes
  4. Connect to Netlify manually (the netlify.toml file is the one you'll need to make sure stays intact to make sure the export is done and pointed to the right stuff)

Styling

Included are some basic styles with styled-jsx, which is included out of the box with Next.js. Because this uses Next.js 9.3, there's also built-in Sass support and CSS Module support, if you'd prefer to use those.

The font used is Inter.

Hero images

You may include an optional hero image in your posts. Put the images in public/static/, and then include in your blog .md file like so:

---
title: 'Post title'
author: 'Post author'
date: '2020-04-27'
hero_image: ../static/example.jpg
---

See demo-post-1.md for an example of this.

next-netlify-blog-starter's People

Contributors

cassidoo avatar ryanhell avatar jamtur01 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.