Skip to content

Commit 2ec37ec

Browse files
authored
Merge pull request #16 from sscargal/site-updates
Site updates
2 parents d3430ef + c4b8f86 commit 2ec37ec

File tree

3 files changed

+139
-12
lines changed

3 files changed

+139
-12
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing to MemMachine Website
2+
3+
Thank you for your interest in contributing! We welcome pull requests, bug reports, and suggestions to improve the MemMachine website.
4+
5+
## How to Contribute
6+
7+
1. **Fork the repository**
8+
9+
- Click the "Fork" button at the top right of the GitHub page.
10+
11+
2. **Clone your fork**
12+
13+
- `git clone https://github.com/MemMachine/memmachine.github.io.git`
14+
15+
3. **Create a new branch**
16+
17+
- `git checkout -b my-feature-branch`
18+
19+
4. **Make your changes**
20+
21+
- Edit content, layouts, styles, or configuration as needed.
22+
23+
5. **Test locally**
24+
25+
- Ensure you have [Hugo](https://gohugo.io/getting-started/installing/) (v0.148.2 or newer) and Node.js installed.
26+
- Run `npm install` if you change frontend assets.
27+
- Start the local server: `hugo server`
28+
- Visit [http://localhost:1313](http://localhost:1313) to preview your changes.
29+
30+
6. **Commit your changes**
31+
32+
- All commits must be signed. See [Commit Signing Instructions](https://github.com/microsoft/vscode/wiki/Commit-Signing) for details.
33+
- Example:
34+
35+
`git commit -sS -m "Describe your change"`
36+
37+
7. **Push to your fork**
38+
39+
- `git push origin my-feature-branch`
40+
41+
8. **Open a pull request**
42+
43+
- Go to the original repository and click "New pull request".
44+
45+
## Guidelines
46+
47+
- Follow the [Hugo documentation](https://gohugo.io/documentation/) for content and theme changes.
48+
- Write clear, descriptive commit messages.
49+
- Keep pull requests focused and concise.
50+
- Ensure your changes do not break the build or site navigation.
51+
- For bug reports or feature requests, open an issue with details and steps to reproduce.
52+
53+
## License
54+
55+
By contributing, you agree that your contributions will be licensed under the terms of the repository's [LICENSE](./LICENSE).

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
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.

themes/memmachine/layouts/_partials/blog-sidebar.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,6 @@ <h4 style="margin: 60px 0 36px 0; border-bottom: 1px solid rgb(31, 31, 50);" dat
2525
{{ end }}
2626
</div>
2727

28-
{{/* --- ARCHIVES --- */}}
29-
<h4 style="margin: 60px 0 36px 0; border-bottom: 1px solid rgb(31, 31, 50);" data-aos="fade-up" data-aos-duration="1000">
30-
Archives
31-
</h4>
32-
<div class="taxonomy-list" data-aos="fade-up" data-aos-duration="1000">
33-
{{ range (where site.RegularPages "Section" "blog").GroupByDate "January 2006" }}
34-
{{ $firstPage := index .Pages 0 }}
35-
{{ $url := printf "/blog/%d/%s/" $firstPage.Date.Year ($firstPage.Date.Format "01") }}
36-
<a href="{{ $url | relLangURL }}" class="taxonomy-button">{{ .Key }}</a>
37-
{{ end }}
38-
</div>
39-
4028
{{/* --- TAGS --- */}}
4129
<h4 style="margin: 60px 0 36px 0; border-bottom: 1px solid rgb(31, 31, 50);" data-aos="fade-up" data-aos-duration="1000">
4230
Tags

0 commit comments

Comments
 (0)