https://github.com/infiniteluke/next-static

A simple static blog powered by next.js
https://github.com/infiniteluke/next-static

Last synced: 4 months ago
JSON representation

A simple static blog powered by next.js

• Host: GitHub
• URL: https://github.com/infiniteluke/next-static
• Owner: infiniteluke
• License: mit
• Created: 2017-06-09T21:34:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-13T23:14:21.000Z (almost 7 years ago)
• Last Synced: 2024-06-22T18:47:00.132Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 507 KB
• Stars: 105
• Watchers: 2
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Build Status](https://travis-ci.org/infiniteluke/next-static.svg?branch=master)](https://travis-ci.org/infiniteluke/next-static)

[![David](https://img.shields.io/david/infiniteluke/next-static.svg)]()

# Next Static Blog

__✨ Start static then go server rendered when you need to ✨__

A simple static blog powered by [next.js](https://github.com/zeit/next.js).

## Before Using

This repo could be a good starting place for your simple Next.js powered static site. That said, there are other options out there that are more extensible, well maintained, and  battle tested than this repo. Check them out: https://myles.github.io/awesome-static-generators/

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



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