- Add README.md with comprehensive project overview and setup instructions - Add AGENTS.md with build commands and code style guidelines for development agents
2.9 KiB
2.9 KiB
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 (version 0.100.0 or later)
- Git
Installation
- Clone the repository:
git clone <repository-url>
cd taylors.life
- Build the site:
hugo
- Serve locally for development:
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
hugo server -D # Serve with drafts included
hugo server -D -w # Watch for changes and rebuild
Production
make build # Build the site (output to public/)
make publish # Build and deploy
Manual Build
hugo # Build static files to public/ directory
Content Guidelines
Creating New Posts
- Create a new markdown file in
content/posts/ - Use the date format
YYYY-MM-DD.mdfor dated posts - Include proper front matter:
---
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
- Create a directory in
static/img/[post-name]/ - Add images with descriptive names (no spaces)
- Reference in content using absolute paths:
/img/post-name/image.jpg - 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
- Create content following the guidelines above
- Test locally with
hugo server -D - Ensure images are properly sized and formatted
- Check that all links work correctly
- 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.