πŸ“ 🎨 A clean and delicate theme for blog based on Gatsby.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
contents
scripts
src
static
.gitignore
.prettierrc
LICENSE
README.md
gatsby-config.js
gatsby-node.js
index.js
package.json
yarn.lock

README.md

Build Status

lite

A clean and delicate theme for blog based on Gatsby.

Getting started

Installing lite is quite easy. However, you do need to have a couple of other things installed first:

git clone https://github.com/sqrthree/lite.git myblog
cd myblog
yarn install // or `npm install`

Once initialised, here’s what your project folder will look like:

myblog
β”œβ”€β”€ LICENSE
β”œβ”€β”€ README.md
β”œβ”€β”€ bin
β”œβ”€β”€ config
β”‚Β Β  └── default.yaml
β”œβ”€β”€ contents
β”‚Β Β  └── hello-world.md
β”œβ”€β”€ gatsby-config.js
β”œβ”€β”€ gatsby-node.js
β”œβ”€β”€ index.js
β”œβ”€β”€ package.json
β”œβ”€β”€ src
β”œβ”€β”€ static
β”‚Β Β  β”œβ”€β”€ CNAME
β”‚Β Β  β”œβ”€β”€ README.md
β”‚Β Β  β”œβ”€β”€ favicon.ico
β”‚Β Β  └── robots.txt
└── yarn.lock

All the folders you need to care about

  • config: Site configuration folder, You can configure most settings here.
  • contents: Contents folder, Where you create a new post.

Scripts

yarn run start / npm start

Start a hot-reloading development environment accessible at localhost:8000.

The page will automatically reload if you make changes to the post in contents.

You can get the build errors and lint warnings in the console.

yarn run build / npm run build

Perform an optimized production build to the public folder for your site generating static HTML and per-route JavaScript code bundles.

yarn run serve / npm run serve

Start a local HTML server for testing your built site.

yarn run deploy / npm run deploy

Publish your all files in public to a gh-pages branch on GitHub.

Configuration

You can modify site settings in config/default.yaml.

A better solution is to create a local configuration file, local.yaml, in config folder. All configuration parameters from local.yaml will overwrite default.yaml.

local.yaml is intended to not be tracked in your version control system.

To config/default.yaml to get more details.

Developing

Built With

  • React
  • GraphQL
  • Node.js

Prerequisites

Setting up Dev

git clone https://github.com/sqrthree/lite.git
cd lite
yarn install
yarn run start

LICENSE

This project is licensed under the MIT License.


sqrtthree.com Β Β·Β  GitHub @sqrthree Β Β·Β  Twitter @sqrtthree