A tool to generate a website from an OPAM universe
This utility creates a static website from an OPAM universe, listing all available packages and their details. A homepage and OPAM documentation is included as well.
The latest release of opam2web is available via opam. To install, simply run:
opam install opam2web
- re github.com/ocaml/ocaml-re
- uri github.com/avsm/ocaml-uri
- opam github.com/ocaml/opam
- opamfu github.com/ocamllabs/opamfu
- cow github.com/mirage/ocaml-cow
- cmdliner erratique.ch/software/cmdliner
- js_of_ocaml ocsigen.org/js_of_ocaml
If you have opam installed:
opam install re uri opam-lib opamfu cow cmdliner js_of_ocaml
To build the
opam2web utility, enter:
The binary will be located in src/_build/opam2web.native after compilation.
To generate the static website corresponding to the
default remote in the
local OPAM installation, enter:
make -C src run
opam2web [options]* [repositories]*
Each repository is namespaced by its type:
path:*A repository at the following local file system path.
local:*The repository corresponding to a named opam remote.
opam:The current local opam universe.
The order of repositories determines their priority when generating the opam universe to use. Earlier repositories are higher priority.
If no repository is given, the current local opam universe is used.
Some available options are:
--output / -o [directory]The directory where to write the generated HTML files.
--content / -c [direcory]The directory where to find documentation and templates to use. Defaults to 'content'.
--where [comma-separated predicate list]A package's satisfaction of all of the predicates in any of the lists implies generation.
--index (all|where)Control which packages to include in the universe index.
--help / -helpDisplay the list of options.
Some available predicates are:
For complete command-line configuration options, run
opam2web -o website path:~/myrepo local:default
will generate the HTML files corresponding to the repository located in
~/myrepo and the remote named
default in the local OPAM installation.
Resulting files will be located in the
- More complex news system (one page per news, Markdown...)
- More complex statistics (graphics over time...)