gatsby-starter-minimal-blog

by LekoArts

Typography driven, feature-rich blogging theme with minimal aesthetics. Includes tags/categories sup...

591 Stars 177 Forks Last release: Not found BSD Zero Clause License 417 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

LekoArts

Gatsby Starter: Minimal Blog

Minimal Blog is released under the 0BSD license. PRs welcome! Follow @lekoarts_de

Typography driven, feature-rich blogging theme with minimal aesthetics. Includes tags/categories support and extensive features for code blocks such as live preview, line numbers, and line highlighting. Using the Gatsby Theme

@lekoarts/gatsby-theme-minimal-blog
.

Demo Website

Also be sure to checkout other Free & Open Source Gatsby Themes

✨ Features

  • MDX
  • Fully customizable through the usage of Gatsby Themes (and Theme UI)
  • Light Mode / Dark Mode
  • Typography driven, minimal style
  • Tags/Categories support
  • Code highlighting with prism-react-renderer and react-live support. Also allows adding line numbers, line highlighting, language tabs, and file titles.
  • RSS Feed for blog posts
  • Google Analytics Support
  • SEO (Sitemap, OpenGraph tags, Twitter tags)
  • Offline Support & WebApp Manifest

πŸš€ Getting Started

  1. Create a Gatsby site.

Use the Gatsby CLI to create a new site, specifying this project

gatsby new project-name https://github.com/LekoArts/gatsby-starter-minimal-blog
  1. Start developing.

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

cd project-name
gatsby develop
  1. Open the code and start customizing!

Your site is now running at

http://localhost:8000
!

If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can checkout this shorter or longer tutorial. The tutorials don't exactly apply to this starter however the concepts are the same.

πŸ“ Using and modifying this starter

Important Note: Please read the guide Shadowing in Gatsby Themes to understand how to customize the underlying theme!

This starter creates a new Gatsby site that installs and configures the theme

@lekoarts/gatsby-theme-minimal-blog
.

Have a look at the theme's README and files to see what options are available and how you can shadow the various components including Theme UI. Generally speaking you will want to place your files into

src/@lekoarts/gatsby-theme-minimal-blog/
to shadow/override files. The Theme UI config can be configured by shadowing its files in
src/gatsby-plugin-theme-ui/
.

Code Highlighting

Since the underlying theme ships with prism-react-renderer and react-live certain additional features were added to code blocks. You can find an overview / usage example in the example repository! If you want to change certain code styles or add additional language tabs, you need to shadow the file

src/@lekoarts/gatsby-theme-minimal-blog/styles/code.js
.

Language tabs:

When you add a language (such as e.g.

js
or
javascript
) to the code block, a little tab will appear at the top left corner.
```js
// code goes here
**Code titles:**

You can display a title (e.g. the file path) above the code block.

// code goes here
Or without a specific language:

// code goes here
Line highlighting:

You can highlight single or multiple (or both) lines in a code block. You need to add a language.

js {2,4-5}
const test = 3
const foo = 'bar'
const harry = 'potter'
const hermione = 'granger'
const ron = 'weasley'
````

Hide line numbers:

If you want to hide line numbers you can either globally disable them (see Theme options) or on a block-by-block basis. You can also combine that with the other attributes.

```noLineNumbers
// code goes here
**react-live:**

Add react-live to the code block (and render the component) to see a preview below it.

js react-live
const onClick = () => {
  alert("You opened me");
};
render(Alohomora!);
````

Adding content

Adding a new blog post

New blog posts will be shown on the index page (the three most recent ones) of this theme and on the blog overview page. They can be added by creating MDX files inside

content/posts
. General setup:
  1. Create a new folder inside
    content/posts
  2. Create a new
    index.mdx
    file, and add the frontmatter
  3. Add images to the created folder (from step 1) you want to reference in your blog post
  4. Reference an image as your
    banner
    in the frontmatter
  5. Write your content below the frontmatter

Frontmatter reference:

---
title: Introduction to "Defence against the Dark Arts"
date: 2019-11-07
description: Defence Against the Dark Arts (abbreviated as DADA) is a subject taught at Hogwarts School of Witchcraft and Wizardry and Ilvermorny School of Witchcraft and Wizardry.
tags:
  - Tutorial
  - Dark Arts
banner: ./defence-against-the-dark-arts.jpg
---

The fields

description
and
banner
are optional!
If no description is provided, an excerpt of the blog post will be used. If no banner is provided, the default

siteImage
(from
siteMetadata
) is used.

The

date
field has to be written in the format
YYYY-MM-DD
!

Adding a new page

Additional pages can be created by placing MDX files inside

contents/pages
, e.g. an "About" or "Contact" page. You'll manually need to link to those pages, for example by adding them to the navigation (in
navigation
option of the theme). General instructions:
  1. Create a new folder inside
    content/pages
  2. Create a new
    index.mdx
    file, and add the frontmatter
  3. Write your content below the frontmatter
  4. Optionally add files/images to the folder you want to reference from the page

Frontmatter reference:

---
title: About
slug: "/about"
---

Changing the "Hero" text

To edit the hero text ("Hi, I'm Lupin...), create a file at

src/@lekoarts/gatsby-theme-minimal-blog/texts/hero.mdx
to edit the text.

Changing the "Projects" part

To edit the projects part below "Latest posts", create a file at

src/@lekoarts/gatsby-theme-minimal-blog/texts/bottom.mdx
to edit the contents.

Change your
static
folder

The

static
folder contains the icons, social media images and robots.txt. Don't forget to change these files, too!

πŸ€” Questions or problems?

Please open up an issue on the main repository: LekoArts/gatsby-themes. Thanks!

πŸŽ“ Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on Gatsby's website.

Themes

  • To learn more about Gatsby themes specifically, we recommend checking out the theme docs.

General

🌟 Supporting me

Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on Twitter and share the project with me.

Please star this project, share it on Social Media or consider supporting me on Patreon or GitHub Sponsor!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.