The repository holds everything needed for building myletters website.
The website started from the gatsby-starter-minimal-blog starter which is built on top of a Gatsby theme.
- Install Gatsby CLI.
npm install -g gatsby-cli
- Create a Gatsby site.
Use the Gatsby CLI to create a new site, specifying this project
gatsby new blog-content https://github.com/vezeli/blog-content
- Start developing.
Navigate into your new site's directory and start it up.
cd blog-content
gatsby develop
- 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.
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/
.
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.
```jsx:title=your-title
// code goes here
```
Or without a specific language:
```:title=your-title
// 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(<button onClick={onClick}>Alohomora!</button>);
```
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:
- Create a new folder inside
content/posts
- Create a new
index.mdx
file, and add the frontmatter - Add images to the created folder (from step 1) you want to reference in your blog post
- Reference an image as your
banner
in the frontmatter - 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
!
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:
- Create a new folder inside
content/pages
- Create a new
index.mdx
file, and add the frontmatter - Write your content below the frontmatter
- Optionally add files/images to the folder you want to reference from the page
Frontmatter reference:
---
title: About
slug: "/about"
---
Edit src/@lekoarts/gatsby-theme-minimal-blog/texts/hero.mdx
to change the
landing-page text.
Edit src/@lekoarts/gatsby-theme-minimal-blog/texts/bottom.mdx
to change the
projects part below "Latest posts".
The static
folder contains the icons, social media images and robots.txt.
Don't forget to change these files, too!