Project Structure
Projects are stored as markdown files in thesrc/content/work/ directory. Each project is a separate .md file with frontmatter metadata.
Creating a New Project
Create a new markdown file
Create a new The filename will be used as the URL slug:
.md file in src/content/work/:/work/my-awesome-projectAdd frontmatter metadata
Start with the required frontmatter fields:
src/content/work/my-awesome-project.md
Frontmatter Fields
All projects must include these frontmatter fields:Required Fields
The project title displayed on the card and project page.
A short description of the project. Supports multi-line text using
| syntax.The publication date in
YYYY-MM-DD HH:MM:SS format. Used for sorting projects.An array of tags categorizing the project.
Path to the project thumbnail image, relative to the
public/ directory.Optional Fields
Alternative text for the project image (accessibility).
Real Project Examples
Example 1: AudioGPT
src/content/work/audiogpt.md
Example 2: VST Plugins
src/content/work/vst-plugins.md
Markdown Features
You can use standard markdown formatting:Headings
Lists
Links
Code Blocks
Project Ordering
Projects are displayed in reverse chronological order based on thepublishDate field. More recent projects appear first.
To feature a project at the top, use a future date or a more recent date:
Best Practices
Use descriptive titles
Choose clear, concise titles that accurately represent the project.
Write compelling descriptions
The description appears on project cards. Make it engaging and informative.
Choose relevant tags
Use tags that reflect the technologies and skills demonstrated.
Optimize images
Compress images to reduce file size while maintaining quality.
Validation
The content collection schema automatically validates your projects. If you’re missing required fields or have incorrect data types, you’ll see an error when running the dev server. Run type checking manually:Next Steps
- Content Collections - Understand the schema and validation
- Markdown Frontmatter - Detailed field reference
- Building - Build your portfolio with the new projects