Weasis Documentation Website

Source repository for the Weasis documentation website — covering installation, configuration, tutorials, and more for the Weasis DICOM viewer.

---

🚀 Getting Started

Prerequisites

Before getting started, make sure the following tools are installed:

• Git
• Hugo (extended version recommended)

1. Clone the repository

Clone the repository with its submodules (the Relearn theme):

git clone --recurse-submodules https://github.com/nroduit/nroduit.github.io.git
cd nroduit.github.io

Note: If you already cloned the repository without submodules, initialize them with:

git submodule update --init --recursive

2. Update the theme

cd themes/hugo-theme-relearn
git pull origin main
cd ../..

3. Start the local development server

hugo serve

The site will be available at http://localhost:1313. Hugo automatically reloads the browser on file changes.

Refer to the official Hugo documentation for advanced usage.

---

📁 Project Structure

Path	Description
content/	Markdown source files for all documentation pages
static/	Static assets (images, JS, CSS, attachments)
layouts/	Custom Hugo layout overrides and shortcodes
themes/	Hugo Relearn theme (git submodule)
config.toml	Site configuration

---

✍️ Contributing

Contributions are welcome! To propose a change:

1. Fork the repository and create a new branch.
2. Add or edit Markdown files under content/.
   • Use the *.en.md suffix for English content.
   • Place shared images in static/ (referenced via /images/...).
3. Preview your changes locally with hugo serve.
4. Open a Pull Request against the main branch.

Each published page exposes an Edit this page link that points directly to the corresponding file on GitHub, making small fixes easy.

📚 Useful links

• Weasis project
• Hugo documentation
• Relearn theme documentation