Skip to content

Commit 5442717

Browse files
committed
updated readme
1 parent 0a85a27 commit 5442717

File tree

1 file changed

+46
-2
lines changed

1 file changed

+46
-2
lines changed

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
# EMC-Viroscience.github.io
2-
Hosting manuals
1+
# EMC Viroscience Website
2+
3+
This repository contains the Quarto source code for the EMC Viroscience website, hosted at [https://lucvzon.github.io/EMC-Viroscience.github.io/](https://lucvzon.github.io/EMC-Viroscience.github.io/). The site serves as a central hub for bioinformatics workflow manuals, tool documentation, blog posts, and relevant links for the group.
4+
5+
[![Deploy Quarto Website](https://github.com/LucvZon/EMC-Viroscience.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/LucvZon/EMC-Viroscience.github.io/actions/workflows/deploy.yml)
6+
7+
## Technology
8+
9+
* **Content & Structure:** [Quarto](https://quarto.org/)
10+
* **Hosting:** [GitHub Pages](https://pages.github.com/)
11+
* **Deployment:** Automated via [GitHub Actions](./.github/workflows/deploy.yml)
12+
13+
## Repository Structure
14+
15+
* `_quarto.yml`: Main website configuration (navigation, sidebars, etc.).
16+
* `index.qmd`: Homepage content and top-level listings.
17+
* `posts/`: Source `.qmd` files for blog posts and multi-part manuals. See contribution guide for naming conventions.
18+
* `repos/`: Source `.qmd` files defining specific repository links listed on the homepage.
19+
* `.github/workflows/`: Contains the CI/CD workflow for automatic deployment.
20+
* `docs/`: **(Generated Output)** This directory contains the rendered website. It is automatically generated and deployed by GitHub Actions. **Do not commit changes to this directory manually.**
21+
22+
## Local Preview
23+
24+
To preview the website locally before contributing:
25+
26+
1. Ensure you have [Quarto installed](https://quarto.org/docs/get-started/).
27+
2. Clone this repository: `git clone https://github.com/EMC-Viroscience/EMC-Viroscience.github.io.git`
28+
3. Navigate to the directory: `cd EMC-Viroscience.github.io`
29+
4. Run: `quarto preview`
30+
5. This will render the site locally and open it in your default web browser.
31+
*Note: Remember not to commit the `docs/` directory generated during local preview.*
32+
33+
## Contributing
34+
35+
We welcome contributions! Please see the detailed guide on the website:
36+
37+
* **[How to Contribute Manuals and Content](https://lucvzon.github.io/EMC-Viroscience.github.io/contribute/add_manuals.html)**
38+
39+
In summary, the process involves:
40+
1. Forking the repository.
41+
2. Creating a new branch for your changes.
42+
3. Adding or editing source files (primarily `.qmd` files in `posts/` and potentially `_quarto.yml`).
43+
4. Committing **only the source file changes** to your branch.
44+
5. Pushing your branch to your fork.
45+
6. Opening a Pull Request against the `main` branch of this repository.
46+
7. Once merged, GitHub Actions will automatically render and deploy your changes.

0 commit comments

Comments
 (0)