MichaelHale.xyz

This is a personal portfolio built with Gatsby.js and MDX.

Features

• MDX: JavaScript/React in Markdown
• Styled components
• Typography.js

🚀 Quick start

Setup

• git clone [email protected]:mjhale/portfolio.git
• cd portfolio
• npm install
• gatsby develop
• visit http://localhost:8000

🧐 What's inside?

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

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

1. /content: The directory where all Markdown content is stored.

2. /node_modules: The directory where all of the modules of code that your project depends on (npm packages) are automatically installed.

3. /src: This directory caontains all of the code related to what you see on the front-end.

4. .gitignore: This file tells git which files it should not track / not maintain a version history for.

5. .prettierrc: This is a configuration file for a tool called Prettier, which is a tool to help keep the formatting of your code consistent.

6. 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.

7. 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).

8. 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.

9. 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.

10. LICENSE: Gatsby is licensed under the MIT license.

11. 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).

12. 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.

13. 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:

Attribution

Technology icons by Erik Ragnar Eliasson, https://www.erikeliasson.io/

Photograph of Charlotte by Carissa Rogers, https://unsplash.com/@goodncrazy/portfolio