Lumen

A constantly evolving and thoughtful architecture for creating new static blogs.

Table of contents

• Features
• Web Performance Tests
• Quick Start
• Deploy with Netlify
• Folder Structure
• Sponsors
• Contributors
• License

Features

• Lost Grid.
• Modern font stack.
• Beautiful typography inspired by matejlatin/Gutenberg.
• Syntax highlighting in code blocks using PrismJS.
• Mobile-First approach in development.
• Archive organized by tags and categories.
• Pagination support.
• Netlify CMS support.
• Google Analytics.
• Disqus Comments.
• Flow static type checking.

Web Performance Tests

• Lighthouse Report - WebPageTest
• Visual Comparison - WebPageTest

Quick Start

Create a Gatsby site

Use the Gatsby CLI to create a new site, specifying the Lumen starter.

# Create a new Gatsby site using the Lumen starter
gatsby new blog https://github.com/alxshelepenok/gatsby-starter-lumen

Start Developing

Navigate into your new site’s directory and start it up.

cd blog
gatsby develop

Open the source code and start editing!

Your site is now running at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

Open the blog directory in your code editor of choice and edit src/templates/index-template.js. Save your changes and the browser will update in real time!

Deploy with Netlify

Netlify CMS can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. Use the button below to build and deploy your own copy of the repository:

After clicking that button, you’ll authenticate with GitHub and choose a repository name. Netlify will then automatically create a repository in your GitHub account with a copy of the files from the template. Next, it will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete. Next, you’ll need to set up Netlify’s Identity service to authorize users to log in to the CMS.

Deploy to Github Pages

To deploy to github pages, simply do the following:

• Ensure that your package.json file correctly reflects where this repo lives
• Change the pathPrefix in your config.js
• Run the standard deploy command

yarn deploy

Access Locally

$ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git
$ cd [REPO_NAME]
$ yarn
$ yarn develop

To test the CMS locally, you'll need run a production build of the site:

$ yarn build
$ gatsby serve

Folder Structure

└── content
    ├── pages
    └── posts
└── static
    ├── admin
    └── media
└── src
    ├── assets
    │   └── scss
    │       ├── base
    │       └── mixins
    ├── cms
    │   └── preview-templates
    ├── components
    │   ├── Feed
    │   ├── Icon
    │   ├── Layout
    │   ├── Page
    │   ├── Pagination
    │   ├── Post
    │   │   ├── Author
    │   │   ├── Comments
    │   │   ├── Content
    │   │   ├── Meta
    │   │   └── Tags
    │   └── Sidebar
    │       ├── Author
    │       ├── Contacts
    │       ├── Copyright
    │       └── Menu
    ├── constants
    ├── templates
    └── utils

Sponsors

Development efforts are supported by the sponsors. I'm very grateful for their donations, please check them out!

Contributors

Thanks goes to these wonderful people!

vzhou842	alehel	abisz	remi-bruguier	mariolopjr	ihororlovskyi

timbroder	vinnymac	yodahuang	axelclark	BigTony666	stigrune

ybbarng	marktani	concreted	chmac	charandas	marcelabomfim

zollillo	codejet	reed-jones	rtveitch	SayakaOno	swapnilmishra

vvasiloud	vstoms	wichopy	yairmark

License

The MIT License (MIT)

Copyright (c) 2016-2021 Alexander Shelepenok

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.