This repository contains the source code for the alphapept proteomics software ecosystem website, built with Hugo and the PaperMod theme.
This is a work-in-progress, the preliminary name is alphapept
To be announced
content/
├── _index.md # Homepage
├── ecosystem/ # Ecosystem
│ ├── _index.md # Ecosystem overview
│ ├── walkthrough.md # (work in progress: More detailed description of individual components+interplay)
| └──packages/ # Ignored
| *.md # More detailed description of individual packages
├── mission.md # Mission and goals
├── community/ # Community, Contributors, Guidelines
│ ├── _index.md #
│ ├── contributors.md # Current and former contributors
│ ├── guidelines.md # Code of conduct, Diversity/Equity/Inclusion etc.
| └── join # How to contribute
└── news/ # News and blog posts
├── _index.md # News overview
└── *.md # Individual news posts
-
Clone the repository:
git clone https://github.com/alphapept-team/alphaX-website.git cd alphaX-website -
Initialize the theme submodule:
git submodule update --init --recursive
-
Start the development server:
hugo server -D
-
Open your browser and navigate to
http://localhost:1313
- Content: Edit Markdown files in the
content/directory - Configuration: Modify
hugo.tomlfor site-wide settings - Layouts: Custom layouts are in
layouts/directory. Specifically, you can generate templates for specific structures (e.g. the Package/Contributor Cards and grids in/layouts/shortcodeswith templated HTML+CSS) - Static files: Images and other assets go in
static/directory
To add a new package:
- Create a new Markdown file in
content/packages/ - Add front matter with title, description, and date
- Use the feature card shortcode on the packages index page
Example:
---
title: "New Package"
description: "Description of the new package"
date: 2024-01-15
---Ignore subsites (e.g. if you only want to be able to link to a specific site)
---
...
_build:
list: false
cascade:
_build:
list: false
---
Your content here...To add a news post:
- Create a new Markdown file in
content/news/with date prefix - Add appropriate front matter and tags
- The post will automatically appear in the news feed
Example:
---
title: "Exciting News"
date: 2024-01-15T10:00:00Z
description: "Brief description"
tags: ["announcement", "release"]
---
Your news content here...The site includes custom shortcodes for consistent styling (see /layouts/shortcodes):
Key configuration options in hugo.toml:
- Site metadata: Title, description, author
- Navigation menu: Top-level menu items
- PaperMod parameters: Theme-specific settings
- Social links: GitHub, Twitter, etc.
The site automatically deploys to GitHub Pages when changes are pushed to the main branch using GitHub Actions.
To build the site manually:
hugo --minifyThe generated site will be in the public/ directory.
We welcome contributions to improve the website! Please:
- Fork the repository
- Create a feature branch
- Make your changes
- Test locally with
hugo server - Submit a pull request
- Use clear, concise language
- Include code examples where appropriate
- Add appropriate tags to news posts
- Optimize images for web use
- Follow the existing content structure
- Follow Hugo best practices
- Test locally before submitting PRs
- Use semantic HTML in custom layouts
- Ensure responsive design
- Maintain accessibility standards
This website is licensed under the MIT License. See LICENSE for details.
- Issues: GitHub Issues
- Hugo - Static site generator
- PaperMod - Hugo theme
- GitHub Pages - Hosting platform
- All contributors who help improve the site
Built with ❤️ by the alphapept community