1
0
Files
www.taylors.life/README.md
Eric Taylor 874156bb0d Add project documentation files
- Add README.md with comprehensive project overview and setup instructions
- Add AGENTS.md with build commands and code style guidelines for development agents
2025-12-25 12:13:28 -05:00

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

  1. Clone the repository:
git clone <repository-url>
cd taylors.life
  1. Build the site:
hugo
  1. 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

  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:
---
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.