diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..19d391d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing to MemMachine Website + +Thank you for your interest in contributing! We welcome pull requests, bug reports, and suggestions to improve the MemMachine website. + +## How to Contribute + +1. **Fork the repository** + + - Click the "Fork" button at the top right of the GitHub page. + +2. **Clone your fork** + + - `git clone https://github.com/MemMachine/memmachine.github.io.git` + +3. **Create a new branch** + + - `git checkout -b my-feature-branch` + +4. **Make your changes** + + - Edit content, layouts, styles, or configuration as needed. + +5. **Test locally** + + - Ensure you have [Hugo](https://gohugo.io/getting-started/installing/) (v0.148.2 or newer) and Node.js installed. + - Run `npm install` if you change frontend assets. + - Start the local server: `hugo server` + - Visit [http://localhost:1313](http://localhost:1313) to preview your changes. + +6. **Commit your changes** + + - All commits must be signed. See [Commit Signing Instructions](https://github.com/microsoft/vscode/wiki/Commit-Signing) for details. + - Example: + + `git commit -sS -m "Describe your change"` + +7. **Push to your fork** + + - `git push origin my-feature-branch` + +8. **Open a pull request** + + - Go to the original repository and click "New pull request". + +## Guidelines + +- Follow the [Hugo documentation](https://gohugo.io/documentation/) for content and theme changes. +- Write clear, descriptive commit messages. +- Keep pull requests focused and concise. +- Ensure your changes do not break the build or site navigation. +- For bug reports or feature requests, open an issue with details and steps to reproduce. + +## License + +By contributing, you agree that your contributions will be licensed under the terms of the repository's [LICENSE](./LICENSE). diff --git a/README.md b/README.md new file mode 100644 index 0000000..f47929f --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# MemMachine Website + +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. + +## Project Structure + +- `hugo.toml` — Main Hugo configuration file +- `archetypes/` — Archetype templates for new content +- `content/` — Site content (pages, blog posts, etc.) +- `data/` — Structured data files (YAML) +- `public/` — Generated static site output (do not edit directly) +- `resources/` — Hugo-generated resources +- `static/` — Static assets (images, text files, etc.) +- `themes/` — Hugo themes (main: `memmachine`) +- `package.json` — Node.js dependencies for asset building +- `postcss.config.js` — PostCSS configuration + +## Getting Started + +### Prerequisites + +- [Hugo](https://gohugo.io/getting-started/installing/) (version 0.148.2 or newer) +- [Node.js](https://nodejs.org/) (for asset building) + +### Installation + +1. Install Hugo (version 0.148.2 or newer): + + See the [official Hugo installation guide](https://gohugo.io/getting-started/installing/) for your platform, or use Homebrew (macOS/Linux): + + ```bash + brew install hugo + # Or, to upgrade: + brew upgrade hugo + # Or, download from https://github.com/gohugoio/hugo/releases + ``` + + To verify your Hugo version: + + ```bash + hugo version + # Should be 0.148.2 or newer + ``` + +2. Clone the repository: + + ```bash + git clone https://github.com/sscaragal/memmachine.github.io.git + cd memmachine.github.io + ``` + +3. Install Node.js dependencies: + + ```bash + npm install + ``` + +### Local Development + +To start a local development server: + +```bash +hugo server +``` + +Visit [http://localhost:1313](http://localhost:1313) to view the site. + +### Building the Site + +To build the static site for production: + +```bash +hugo +``` + +The output will be in the `public/` directory. + +## Contributing + +Pull requests and issues are welcome! Please follow the [Hugo documentation](https://gohugo.io/documentation/) for content and theme changes. + +## License + +See [LICENSE](./LICENSE) for details. diff --git a/themes/memmachine/layouts/_partials/blog-sidebar.html b/themes/memmachine/layouts/_partials/blog-sidebar.html index 00487a7..b035a1f 100644 --- a/themes/memmachine/layouts/_partials/blog-sidebar.html +++ b/themes/memmachine/layouts/_partials/blog-sidebar.html @@ -25,18 +25,6 @@