Skip to content

pyladies-vancouver/pyladies-vancouver.github.io

Repository files navigation

Vancouver PyLadies Static Site

Logo

Welcome to the Vancouver PyLadies static site! This project is built with Hugo and uses Hinode as a theme. The site is deployed via Netlify.

πŸš€ Getting Started

Prerequisites

Ensure you have the following installed on your system:

Installation

  1. Clone the repository
git clone https://github.com/yourusername/vancouver-pyladies-site.git
cd vancouver-pyladies-site
  1. Install Hugo Modules
hugo mod get -u
  1. Install Node.js dependencies for PostCSS processing
npm install

πŸ“ Project Structure

β”œβ”€β”€ archetypes/      # Template files for new content
β”œβ”€β”€ assets/          # Uncompiled CSS, JS, images
β”œβ”€β”€ config/          # Settings and options
β”œβ”€β”€ content/         # Site content (Markdown files)
β”œβ”€β”€ layouts/         # HTML templates
β”œβ”€β”€ public/          # Processed static files
β”œβ”€β”€ static/          # Unprocessed static files (copied as-is)
β”œβ”€β”€ go.mod           # Go module definition
β”œβ”€β”€ hinode.work      # Hinode module definition
β”œβ”€β”€ hugo.toml        # Hugo configuration
└── package.json     # Node.js dependencies

βš’οΈ Development

Start Hugo's local development server

hugo server -D

This starts a local server with drafts enabled (-D) and watches for file changes. The site will be available at http://localhost:1313/.

🀝 Contributing

  1. Fork the repository
  2. Create a new branch:
git checkout -b your-branch-name
  1. Make your changes
  2. Test your changes locally using hugo server
  3. Commit your changes:
git add .
git commit -m "Add your meaningful commit message"
  1. Push to your fork:
git push origin your-branch-name
  1. Create a Pull Request

πŸ“œ License

This project is licensed under the MIT license.