diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..41f89d3 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,39 @@ +# Taylors.Life Development Guide + +This is a Hugo static site for family content and blog posts. + +## Build Commands +- `hugo` - Build the site +- `make build` - Build using makefile +- `make 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 \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..002a123 --- /dev/null +++ b/README.md @@ -0,0 +1,126 @@ +# Taylors.Life + +A Hugo-powered static site showcasing family adventures, stories, and memories. + +## About + +Taylors.Life is a family blog that captures our adventures, daily life, and special moments. Built with Hugo for fast loading times and easy maintenance, featuring: + +- Family stories and photos +- Outdoor adventures and trips +- Seasonal updates and celebrations +- Personal reflections and quotes + +## Quick Start + +### Prerequisites + +- [Hugo](https://gohugo.io/getting-started/installing/) (version 0.100.0 or later) +- Git + +### Installation + +1. Clone the repository: +```bash +git clone +cd taylors.life +``` + +2. Build the site: +```bash +hugo +``` + +3. Serve locally for development: +```bash +hugo server -D +``` + +Visit `http://localhost:1313` to view the site. + +## Project Structure + +``` +taylors.life/ +├── content/ # All content files +│ about/ # Family member pages +│ posts/ # Blog posts +│ └── links/ # Links and resources +├── static/ # Static assets (images, CSS, JS) +├── layouts/ # Custom template overrides +├── themes/ # Hugo themes +├── config.toml # Hugo configuration +├── Makefile # Build commands +└── README.md # This file +``` + +## Building and Deployment + +### Development +```bash +hugo server -D # Serve with drafts included +hugo server -D -w # Watch for changes and rebuild +``` + +### Production +```bash +make build # Build the site (output to public/) +make publish # Build and deploy +``` + +### Manual Build +```bash +hugo # Build static files to public/ directory +``` + +## Content Guidelines + +### Creating New Posts + +1. Create a new markdown file in `content/posts/` +2. Use the date format `YYYY-MM-DD.md` for dated posts +3. Include proper front matter: + +```yaml +--- +title: "Post Title" +date: YYYY-MM-DD +draft: false +tags: [tag1, tag2, tag3] +author: Author Name +typora-root-url: ../../static +featuredImage: "/img/post-name/feature.jpg" +--- +``` + +### Adding Images + +1. Create a directory in `static/img/[post-name]/` +2. Add images with descriptive names (no spaces) +3. Reference in content using absolute paths: `/img/post-name/image.jpg` +4. Always include alt text for accessibility + +### Shortcodes + +- Video: `{{< video width="640" height="360" src="/path/to/video.mp4" >}}` +- Instagram: `{{< instagram >}}` + +## Theme + +This site uses the `hugo-theme-minos` theme with potential customizations in the `layouts/` directory. + +## Contributing + +1. Create content following the guidelines above +2. Test locally with `hugo server -D` +3. Ensure images are properly sized and formatted +4. Check that all links work correctly +5. Submit changes for review + +## License + +Personal family project. All content and photography remains family copyright. + +## Contact + +For questions about this site, reach out to the family maintainers. \ No newline at end of file