Local development environment
Steps for running and editing this site locally.
Requirements
| Item | Version |
|---|---|
| Node.js | 22.12 or later (24 LTS recommended) |
| Package manager | yarn (this repository is managed with yarn.lock, so do not use npm install) |
| Git | Any recent version |
Setup
The repository is private, so cloning requires administrator privileges (GitHub repository access).
# Clone the repository
git clone https://github.com/rasshii/tech-notes.git
cd tech-notes
# Install dependencies
yarn install
# Start the local server (http://localhost:3000)
yarn start
Verifying the build
To check that the build passes before deploying to production:
yarn build
yarn serve
yarn build outputs the static site to the build/ directory. yarn serve hosts it locally.
Adding articles
Markdown / MDX syntax is documented in the Markdown syntax reference.
Blog posts
Add a Markdown file under blog/. The recommended naming convention is YYYY-MM-DD-slug.md.
---
slug: example-post
title: Article title
authors: [rasshii]
tags: [tag1, tag2]
date: 2026-05-01
---
Opening summary (shown in the list)
<!-- truncate -->
Body...
Documentation articles
Add Markdown under docs/. You can control the order with sidebar_position.
---
sidebar_position: 1
title: Document title
---
Body...
Deployment
When you push to the main branch, Vercel builds and deploys automatically. A preview deploy URL is generated automatically for PR branches, accessible from the PR comments.
See vercel.json at the repository root for the routing configuration.