My Blog

My blog is built with GatsbyJS, initialized with Gatsby's Hello World Starter, and customized with:

SEO component for static pages, and dynamically generated content per post, including Facebook Open Graph and Twitter meta tags.
Pagination.
Optimized images and per post featured image.
Navigation for desktop and mobile responsive menu collapse/expand.
SVG icons from react-icons.
Custom 404 page.
Syntax highlighting with gatsby-remark-vscode.
RSS with gatsby-plugin-feed, validate

Setup

In terminal at root of project, run:

touch .env.development
echo "HELLO_URL=http://localhost:3000/visits" >> .env.development
touch .env.production
echo "HELLO_URL=https://replace.with.hello.host/visits" >> .env.production
npm install

Development

Generate a new post:

./scripts/generate-post.sh my-article-title my-category
# generates markdown file at: src/markdown/my-article-title.md

In a terminal at root of project, run:

make dev

If some pages don't refresh as expected, try this task which will first wipe out the cache:

make devclean

GraphQL queries to get distinct categories:

{
  posts: allMarkdownRemark(
    filter: { fileAbsolutePath: { regex: "/src/markdown/" } }
    sort: {frontmatter: {category: ASC}}
  ) {
    distinct(field: { frontmatter: { category: SELECT} })
  }
  courses: allMarkdownRemark(
    filter: { fileAbsolutePath: { regex: "/src/learning/" } }
    sort: {frontmatter: {category: ASC}}
  ) {
    distinct(field: { frontmatter: { category: SELECT} })
  }
}

To test the production build locally:

make serve

To deploy to Github Pages:

make deploy

Format Code

npm run format

Testing

Run all tests and exit:

make test

Run tests in watch mode:

make testw

Run just one test by describe and it strings:

For example, given a test like:

describe("Course", () => {
  it("renders correctly", () => {
    // test body...
  })
  it("other test", () => {
    // some other stuff...
  })
})

To run just the renders correctly test:

node_modules/.bin/jest -t "Course renders correctly"

Markdown Links

To another post:

[Part 1: Search Introduction](../roll-your-own-search-service-for-gatsby-part1)

To a specific section (within same or other post):

[post template](../gatsby-related-posts#post-template)

Image in src/images:

![image alt text](../images/image-file-name.png "image description")

Markdown Styling

Add entry mapping markdown element to a css class in in gatsby-config.js under the plugins -> gatsby-transformer-remark section.
Add css styles for the class in src/styles/markdown.css.

Fonts

This project uses Fontsource to self host Google fonts. Fonts used include:

figtree

Weights: [300,400,500,600,700,800,900] Styles: [italic,normal]

Gatsby Upgrade Checklist

4 - 5

The following all needs to work:

References

Original Docs from Starter

Gatsby's hello-world starter

Kick off your project with this hello-world boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.

Have another more specific idea? You may want to check out our vibrant collection of official and community-created starters.

🚀 Quick start

Create a Gatsby site.

Use the Gatsby CLI to create a new site, specifying the hello-world starter.

# create a new Gatsby site using the hello-world starter
gatsby new my-hello-world-starter https://github.com/gatsbyjs/gatsby-starter-hello-world

Start developing.

Navigate into your new site’s directory and start it up.
```
cd my-hello-world-starter/
gatsby develop -H 0.0.0.0
```
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 my-hello-world-starter directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .prettierrc
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md

/node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
/src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.
.gitignore: This file tells git which files it should not track / not maintain a version history for.
.prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.
gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.
gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).
gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
gatsby-ssr.js: This file is where Gatsby expects to find any usage of the Gatsby server-side rendering APIs (if any). These allow customization of default Gatsby settings affecting server-side rendering.
LICENSE: Gatsby is licensed under the MIT license.
package-lock.json (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).
package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.
README.md: A text file containing useful reference information about your project.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.
To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

danielabar/meblog