- Add README.md with comprehensive project overview and setup instructions - Add AGENTS.md with build commands and code style guidelines for development agents
1.2 KiB
1.2 KiB
Taylors.Life Development Guide
This is a Hugo static site for family content and blog posts.
Build Commands
hugo- Build the sitemake build- Build using makefilemake publish- Build and deploy site
Testing
No formal test suite. Verify build outputs locally before deployment.
Code Style Guidelines
Front Matter (Markdown)
- Use YAML front matter with title, date, draft, tags, author
- Include featuredImage path when using images
- File names: YYYY-MM-DD.md for dated posts, kebab-case otherwise
- Use typora-root-url: ../../static for local image previews
Content Structure
- Store images in /static/img/[post-name]/
- Use relative image paths in content: /img/[post-name]/image.jpg
- Include alt text for all images
- Use HTML5 semantic elements where appropriate
Shortcodes
- Video:
{< video width="640" height="360" src="/path/to/video.mp4" >} - Instagram:
{< instagram >}for embeds
Naming Conventions
- Post directories: kebab-case matching post title
- Image files: descriptive names, no spaces
- Tags: lowercase, space-separated in brackets
Git Workflow
- Draft posts: draft: true in front matter
- Only commit when explicitly requested
- Use descriptive commit messages