28 lines
838 B
Markdown
28 lines
838 B
Markdown
---
|
|
title: Developer Onboarding
|
|
section: dev-notes
|
|
summary: Quick start steps to clone, install dependencies, and generate the site locally
|
|
tags: [onboarding, setup]
|
|
nav: 1
|
|
---
|
|
|
|
## Getting started
|
|
|
|
1. Clone the repository and install Node 20+.
|
|
2. Run `npm install` to pull dependencies.
|
|
3. Build with `npm run build`; output lands in `dist/`.
|
|
4. Serve `dist/` via any static server (e.g., `npx serve dist`).
|
|
|
|
## Directory overview
|
|
|
|
- `content/`: Markdown notes with front matter.
|
|
- `templates/`: HTML shells for header, footer, and layout.
|
|
- `assets/`: CSS and JavaScript shared across pages.
|
|
|
|
## Conventions
|
|
|
|
- Use kebab-case filenames.
|
|
- For organization, use sections defined in `sections.json` and include section in filename.
|
|
- Keep summaries short; they populate listings and the search index.
|
|
- Add tags to improve search results.
|