/opam2web

A tool to generate a website from an OPAM repository
  1. OCaml 75.9%
  2. CSS 15.9%
  3. HTML 3.7%
  4. Standard ML 1.9%
  5. Makefile 1.4%
  6. JavaScript 1.2%
OCaml CSS HTML Standard ML Makefile JavaScript
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
content Missing spacing & cosmetic changes Jun 28, 2017
ext Tiny js to make anchors clickable Jul 27, 2015
src Drop cache of non-requested log files Jun 28, 2017
.gitignore Update .gitignore and README.md Sep 19, 2013
.gitmodules Fixed old links to github/OCamlPro instead of github/ocaml Feb 21, 2014
.merlin .merlin: don't forget apalog Aug 10, 2014
.travis.yml test ocaml 4.03 and update CHANGES for 1.5.0 release Jun 24, 2017
CHANGES test ocaml 4.03 and update CHANGES for 1.5.0 release Jun 24, 2017
LICENSE Including LICENSE, and switching headers to LGPL Sep 23, 2013
Makefile Fix search.js creation Jan 22, 2015
README.md README: mention that opam2web is published via opam. Mar 8, 2014
opam Require js_of_ocaml-camlp4 Jun 24, 2017

README.md

opam2web

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

Prerequisties

If you have opam installed:

opam install re uri opam-lib opamfu cow cmdliner js_of_ocaml

Build

To build the opam2web utility, enter:

make

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

Usage

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 / -help Display the list of options.

Some available predicates are:

  • tag:*
  • depopt
  • not:*
  • repo:*
  • pkg:*

For complete command-line configuration options, run

opam2web --help

Example

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 website directory.

TODO

  • More complex news system (one page per news, Markdown...)
  • More complex statistics (graphics over time...)