Git Product home page Git Product logo

next-static's Introduction

styled with prettier Build Status David

Next Static Blog

โœจ Start static then go server rendered when you need to โœจ

A simple static blog powered by next.js.

Why

  • I found other SSG (Static Site Generator) to be too much for what I need
  • I wanted to be able to transition to a dynamic site easily if need be and next.js is a great existing SSR (Server Side Render) framework.

Getting Started

  • Fork this repo
  • yarn
  • Edit config/index.js to your liking.
    • Get the best experience with config by adding a plugin to your text editor that will surface flow errors. This will ensure you're providing the expected types for your config values.
  • yarn dev
  • Write! ๐Ÿ“

Writting

  • Create a .md file in posts.
  • Add front matter separated by --- and the body of the post in markdown below:
---
title: Title
slug: slug
author: Your Name
date: 2017-6-10 15:00 PDT
tags:
  - tags
  - go here
---
## Post
Use markdown to _write_ your post
Here's some code:
```javascript
const a = 'thing';
```
  • While writing, run yarn dev to see your post live reload when saved.
  • Re-run yarn export to build your new site.

Default Build

screen shot 2017-08-25 at 2 26 18 pm

Updating Next Static

Currently Next Static is not packaged an distributed on NPM. In order to receive updates you will need to do something like this:

  • Inside the your fork git remote add upstream [email protected]:infiniteluke/next-static.git
  • git merge upstream master
  • To the extent that you hack Next Static, you will need to resolve merge conflicts.
  • I'm open to ideas on how to best package this and make the update process as simple as bumping versions.

next-static's People

Contributors

infiniteluke avatar

Watchers

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