838 B
838 B
title, section, summary, tags, nav
| title | section | summary | tags | nav | ||
|---|---|---|---|---|---|---|
| Developer Onboarding | dev-notes | Quick start steps to clone, install dependencies, and generate the site locally |
|
1 |
Getting started
- Clone the repository and install Node 20+.
- Run
npm installto pull dependencies. - Build with
npm run build; output lands indist/. - 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.jsonand include section in filename. - Keep summaries short; they populate listings and the search index.
- Add tags to improve search results.