Skip to content

mmmaaatttttt/personal-site

Repository files navigation

mattlane.us

Source code for Matt Lane's mathematical personal site.

Live Site

mattlane.us

Setup

npm install
npm run develop

This is a static site built with Gatsby.js. If you have trouble setting up an installation locally, try checking out their docs.

Writing Stories

To add a post, add a new markdown file in src/pages/stories. Each markdown file should begin with some YAML frontmatter with the following data:

  • title
  • date
  • featured_image, which should match the filename of an image in the src/images/featured_images directory
  • caption, a short description of the story which will appear on the /stories index page, as well as in any shares of the story on Facebook / Twitter.
  • featured_image_caption, a caption for the featured image

All visualizations in stories are built using React.js. To add a visualization, you can write the root React component directly in the markdown file, using JSX syntax. All components used for visualizations in stories should live inside of src/story_components.

The site uses gatsby-mdx for processing React components within the markdown. You can import components directly within .mdx files.

Deploying

The site is deployed to S3 with some Route53 and CloudFront sprinkled on top. The setup basically mirrors this article.

Because of this, the command to deploy the site npm run deploy is heavily dependent on this configuration. If you'd like to take this code and deploy using some other technology (e.g. GitHub Pages), you'll need to modify the deploy script in the package.json.

Enjoy!

About

Personal Site built with Gatsby.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published