|
| 1 | +# MemMachine Website |
| 2 | + |
| 3 | +This repository contains the source code and content for the MemMachine website, built with [Hugo](https://gohugo.io/), a fast and flexible static site generator. |
| 4 | + |
| 5 | +## Project Structure |
| 6 | + |
| 7 | +- `hugo.toml` — Main Hugo configuration file |
| 8 | +- `archetypes/` — Archetype templates for new content |
| 9 | +- `content/` — Site content (pages, blog posts, etc.) |
| 10 | +- `data/` — Structured data files (YAML) |
| 11 | +- `public/` — Generated static site output (do not edit directly) |
| 12 | +- `resources/` — Hugo-generated resources |
| 13 | +- `static/` — Static assets (images, text files, etc.) |
| 14 | +- `themes/` — Hugo themes (main: `memmachine`) |
| 15 | +- `package.json` — Node.js dependencies for asset building |
| 16 | +- `postcss.config.js` — PostCSS configuration |
| 17 | + |
| 18 | +## Getting Started |
| 19 | + |
| 20 | +### Prerequisites |
| 21 | + |
| 22 | +- [Hugo](https://gohugo.io/getting-started/installing/) (version 0.148.2 or newer) |
| 23 | +- [Node.js](https://nodejs.org/) (for asset building) |
| 24 | + |
| 25 | +### Installation |
| 26 | + |
| 27 | +1. Install Hugo (version 0.148.2 or newer): |
| 28 | + |
| 29 | + See the [official Hugo installation guide](https://gohugo.io/getting-started/installing/) for your platform, or use Homebrew (macOS/Linux): |
| 30 | + |
| 31 | + ```bash |
| 32 | + brew install hugo |
| 33 | + # Or, to upgrade: |
| 34 | + brew upgrade hugo |
| 35 | + # Or, download from https://github.com/gohugoio/hugo/releases |
| 36 | + ``` |
| 37 | + |
| 38 | + To verify your Hugo version: |
| 39 | + |
| 40 | + ```bash |
| 41 | + hugo version |
| 42 | + # Should be 0.148.2 or newer |
| 43 | + ``` |
| 44 | + |
| 45 | +2. Clone the repository: |
| 46 | + |
| 47 | + ```bash |
| 48 | + git clone https://github.com/sscaragal/memmachine.github.io.git |
| 49 | + cd memmachine.github.io |
| 50 | + ``` |
| 51 | + |
| 52 | +3. Install Node.js dependencies: |
| 53 | + |
| 54 | + ```bash |
| 55 | + npm install |
| 56 | + ``` |
| 57 | + |
| 58 | +### Local Development |
| 59 | + |
| 60 | +To start a local development server: |
| 61 | + |
| 62 | +```bash |
| 63 | +hugo server |
| 64 | +``` |
| 65 | + |
| 66 | +Visit [http://localhost:1313](http://localhost:1313) to view the site. |
| 67 | + |
| 68 | +### Building the Site |
| 69 | + |
| 70 | +To build the static site for production: |
| 71 | + |
| 72 | +```bash |
| 73 | +hugo |
| 74 | +``` |
| 75 | + |
| 76 | +The output will be in the `public/` directory. |
| 77 | + |
| 78 | +## Contributing |
| 79 | + |
| 80 | +Pull requests and issues are welcome! Please follow the [Hugo documentation](https://gohugo.io/documentation/) for content and theme changes. |
| 81 | + |
| 82 | +## License |
| 83 | + |
| 84 | +See [LICENSE](./LICENSE) for details. |
0 commit comments