|
| 1 | +# Vancouver PyLadies Static Site |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +Welcome to the Vancouver PyLadies static site! This project is built with [Hugo](https://gohugo.io/) and uses [Hinode](https://gethinode.com/) as a theme. The site is deployed via [Netlify](https://www.netlify.com/). |
| 6 | + |
| 7 | + |
| 8 | +## 🚀 Getting Started |
| 9 | + |
| 10 | +### **Prerequisites** |
| 11 | +Ensure you have the following installed on your system: |
| 12 | + |
| 13 | +- [Go](https://go.dev/doc/install) |
| 14 | +- [Hugo](https://gohugo.io/getting-started/installing/) |
| 15 | +- [Node.js](https://nodejs.org/) & [npm](https://www.npmjs.com/) |
| 16 | + |
| 17 | +### **Installation** |
| 18 | + |
| 19 | +1. **Clone the repository** |
| 20 | +```sh |
| 21 | +git clone https://github.com/yourusername/vancouver-pyladies-site.git |
| 22 | +cd vancouver-pyladies-site |
| 23 | +``` |
| 24 | + |
| 25 | +2. **Install Hugo Modules** |
| 26 | +```sh |
| 27 | +hugo mod get -u |
| 28 | +``` |
| 29 | +3. **Install Node.js dependencies for PostCSS processing** |
| 30 | +```sh |
| 31 | +npm install |
| 32 | +``` |
| 33 | + |
| 34 | +## 📁 Project Structure |
| 35 | + |
| 36 | +``` |
| 37 | +├── archetypes/ # Template files for new content |
| 38 | +├── assets/ # Uncompiled CSS, JS, images |
| 39 | +├── config/ # Settings and options |
| 40 | +├── content/ # Site content (Markdown files) |
| 41 | +├── layouts/ # HTML templates |
| 42 | +├── public/ # Processed static files |
| 43 | +├── static/ # Unprocessed static files (copied as-is) |
| 44 | +├── go.mod # Go module definition |
| 45 | +├── hinode.work # Hinode module definition |
| 46 | +├── hugo.toml # Hugo configuration |
| 47 | +└── package.json # Node.js dependencies |
| 48 | +``` |
| 49 | + |
| 50 | +## ⚒️ Development |
| 51 | + |
| 52 | +**Start Hugo's local development server** |
| 53 | + |
| 54 | +```sh |
| 55 | +hugo server -D |
| 56 | +``` |
| 57 | + |
| 58 | +This starts a local server with drafts enabled (-D) and watches for file changes. The site will be available at http://localhost:1313/. |
| 59 | + |
| 60 | +## 🤝 Contributing |
| 61 | + |
| 62 | +1. Fork the repository |
| 63 | +2. Create a new branch: |
| 64 | +```bash |
| 65 | +git checkout -b your-branch-name |
| 66 | +``` |
| 67 | +3. Make your changes |
| 68 | +4. Test your changes locally using `hugo server` |
| 69 | +5. Commit your changes: |
| 70 | +```bash |
| 71 | +git add . |
| 72 | +git commit -m "Add your meaningful commit message" |
| 73 | +``` |
| 74 | +6. Push to your fork: |
| 75 | +```bash |
| 76 | +git push origin your-branch-name |
| 77 | +``` |
| 78 | +7. Create a Pull Request |
| 79 | + |
| 80 | +## 📜 License |
| 81 | +This project is licensed under the [MIT license](LICENSE). |
0 commit comments