Skip to content

xpcoffee/emerickbosch.com

Repository files navigation

Emerick Bosch's personal site.

Getting started

1. Install dependencies

npm install

2. Start the development server

npm run dev

3. Start coding!

Development

Adding new articles

Articles are MDX files added to /articles. Adding a new file will automatically add a new page.

Frontmatter

Articles have frontmatter that provides metadata about the article to the site. See the metadata that currently gets used here:

---
title: Discord bot flow
description: The sequence of actions taken by a chatbot.
date: 2020-04-19
faIcon: faRobot
---
title
The title of the article.
description
A short description of what the article is about.
date
The date the article was last edited. This is not a blog, this is a collection of notes which will get updated with time.
faIcon
(I realize this is... meh...)
Used to add an FontAwesome icon to the article. It is the name of the module export of that icon in @fortawesome/free-solid-svg-icons. Have a read through the fontAwesome utility to see how this gets used.

Images

Add images to /public/images/, then reference them in the MDX file. Also works for SVGs.

![alt text](/images/my-image.png)

Styling content

This site uses Tailwind. Use the classes as you need them; I recommend using the global-search on their search. If you need to modify an element globally (should be rare) you can do so in global.css.

Deploying/maintaining

The website is built/deployed using AWS CodePipeline.

git push origin master

For more information on/around deployments, see the wiki.