Farzadyz.me

Monitor Analytics

• Install
• Run locally
• Create a new blog post
• Shortcodes

Install

1. Clone the engineering blog repository to your machine:
   $ git clone [email protected]:farskid/farzadyz.me.git
2. Navigate into the engineering blog folder:
   $ cd farzadyz.me
3. Install yarn package manager globally if you don’t already have yarn installed on your machine:
   $ npm install -g yarn
4. Install the dependencies for this project:
   $ yarn
5. You’re ready to run the engineering blog

Run locally

1. Run the development server to spawn a local server on port 3000:
   $ yarn dev
2. Visit http://localhost:3000/ to find your server running.

Deploy

Deploy to a draft URL by running yarn deploy

Deploy to prod by running yarn deploy:prod

Make sure you export the project before deploying

Create a new blog post

Blog posts are stored inside content/posts.

1. Create and checkout a new Git branch for your blog post:
   $ git checkout -b my-blog-post-branch-name
2. Use yarn post:create to create a blog post following the CLI (command-line interface) prompts:
   $ yarn post:create
3. Find your new blog post inside content/posts and write your blog post content using markdown format.
4. Save your file to live refresh the local server and preview your post at http://localhost:3000/. If your changes aren”t visible, you may need to stop and restart the local server to trigger a rebuild:
   $ ^C
$ yarn dev
5. Commit and push your Git branch to the eng-blog repository:
   $ git commit -am "Add new blog post"
$ git push origin my-blog-post-branch-name
6. Create a pull request on GitHub for your Git branch to the eng-blog repository to request that the post is published to the live site.

Edit existing post

Use yarn post:edit to update an existing blog post’s updatedAt frontmatter field. Follow the CLI prompts to choose an existing blog post from the list.

Blog post frontmatter options

Test meta tags and Open Graph locally

1. Run the development server to spawn a local server on port 3000:
   $ yarn dev
2. In another terminal tab, run yarn test:meta to spawn an instance of localtunnel listening to the same port as the development server:
   $ yarn test:meta
3. The localtunnel process will show a URL in the terminal for a temporary deployment of the development server: your url is: https://exampleurl.com
4. Use this URL with the social media platforms (or any other platform using Open Graph) below to test how they’d preview the home page or any post page meta information:

• Twitter card validator
• LinkedIn post inspector
• Facebook Sharing Debugger (requires Facebook login)

Shortcodes

There are a few shortcodes you can use to embed content in markdown.

Tweets

Use the tweet id for the id attribute. For example, in https://twitter.com/farskid/status/1461727317429043201, 1461727317429043201 is the ID.

<Tweet id="1461727317429043201" />

YouTube

Use the YouTube ID for the id attribute. For example in https://www.youtube.com/watch?v=y6aGu0N8z9Q, y6aGu0N8z9Q is the ID.

<Youtube id="y6aGu0N8z9Q" />