Skip to content

haddocking/haddock3-user-manual

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HADDOCK3 User Manual

build deploy book links Codacy Badge

This repository contains the source files for the HADDOCK3 user manual, built with mdbook.

📖 Read the manual online: https://www.bonvinlab.org/haddock3-user-manual

Building Locally

To build and preview the manual locally:

  1. Install mdbook following the installation guide
  2. Run from the repository root:
    mdbook build .
  3. Open doc/index.html in your browser

Repository Structure

  • book.toml - Book configuration (title, authors, output settings)
  • src/ - Markdown content and assets
  • src/SUMMARY.md - Table of contents
  • theme/ - Custom styling and assets

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines on how to contribute to this manual.

Automated Workflows

GitHub Actions automatically:

  • Build and validate the book on pull requests
  • Deploy to GitHub Pages on merge to main
  • Check for broken links

Contributors 7