Implementation of the ocaml.org website.
OCaml HTML CSS Makefile JavaScript Shell
Switch branches/tags
Nothing to show
Permalink
Failed to load latest commit information.
opam.ocaml.org opam.ocaml.org: link script and factor out opam2web style Aug 23, 2014
script Weekly News: remove <script> Aug 10, 2017
site Make 4.06 changelog issues links Nov 6, 2017
template Add an empty querystring → force reload favicon Oct 19, 2017
translations Fix french translation of "Tutorials" Nov 7, 2016
.gitattributes Try to make GitHub see this as a OCaml project Mar 24, 2015
.gitignore Display the "OCaml Weekly News" more prominently Aug 4, 2017
.mailmap Update .mailmap Oct 28, 2014
.merlin Toploop: use a dumb terminal Jul 23, 2017
.travis-ci.sh Retry failed attempt to install packages Jul 7, 2017
.travis.yml Travis: do not use the cache Jul 7, 2017
Dockerfile add a Dockerfile to build the OCaml.org environment Jul 28, 2016
IDEAS.org Remove references to oasis.ocamlcore.org (deprecated) and to the forg… Jan 30, 2017
LICENSE.md Add minimal LICENSE file Mar 2, 2014
Makefile When compiling locally, turn on staging for pre-build too Jul 19, 2015
Makefile.common Factor in Utils common date functions Aug 10, 2017
Makefile.from_html Make scripts before launching the parallel page build Aug 14, 2014
Makefile.from_md Lighter make output Aug 14, 2014
Makefile.opam.ocaml.org opam.ocaml.org: clarify why we are turning off make's dependency feat… Aug 20, 2014
README.md Fix minor typos in README Dec 10, 2016
_headache.conf Add headache configuration according the chosen licenses Mar 1, 2014
_header_content Add headache configuration according the chosen licenses Mar 1, 2014
_header_design Add headache configuration according the chosen licenses Mar 1, 2014
_header_scripts Add headache configuration according the chosen licenses Mar 1, 2014
imported_content.md Complete the import of Korean translations Feb 8, 2014
opam Add a solution to problem 60 Jul 31, 2017
planet_feeds.txt adds the BAP blog Oct 3, 2017

README.md

Travis Build Status

OCAML.ORG PROJECT

This is the source code implementing the ocaml.org website. Information here is relevant only to developers and content contributors. End-users of the website should simply visit the website, which is hosted at http://ocaml.org.

Note: if you just want to edit a page you do not need to follow the instructions below. Simply click on the pen in the top right corner of the page and you will be redirected to that page on GitHub where you can edit it and submit your changes without leaving your browser.

DEPENDENCIES

Dependencies can be installed by running make deps, which runs the necessary OPAM commands. See the opam file for more information on the required packages.

Note this is the only purpose of the opam file. This repository doesn't provide any resources intended for use in other projects, so it is not provided as a package in any opam repository.

In addition to the above opam packages, it is expected that the following programs are available:

  • bash
  • curl
  • rsync
  • GNU make

BUILD

The site consists only of static pages, so it can be built and run entirely on a local machine without dependencies on external file or database servers. Simply run:

make

(or make -j for a faster build on multicore machines. NB: you might need to limit the number of forks e.g make -j 8 ref).

This will generate a new folder ocaml.org that contains the full website. Note that building the site will attempt to connect to the Internet to download the news and latest email conversations. As usual, use make clean to delete the files generated by the compilation.

DIRECTORY STRUCTURE

site — Main content of the site. Most files are in Markdown syntax and converted to HTML by the build scripts.

template — Templates governing the overall look and feel of the site. These are applied to the pages within site/ when the site is built. References to templates within site pages should be of the form template/template-file-name because the build script assumes this directory structure.

script — Scripts used to build the site.

CONTACTS

For general discussion about the site's implementation, you can post to the infrastructure mailing list.

For a specific bug report, content suggestion, or feature request, please create an issue on GitHub. Or best of all, fork the repo, make changes to your copy, and submit pull requests. It's that easy!