This repository contains the static pages of the Coq website
make
make runPre-html sources are in pages/ and news/, while final html files
will be assembled in dest/.
Note that links may not work locally, and pages will have to have .html appended to the URL in order to view them.
The html files are pre-processed by Yamlpp. A copy of
yamlpp is included in this repository, we simply need an OCaml
toplevel to run it as a script. If you further modify the source
file yamlpp.mll to customize the pre-processing, you will also need
ocamllex to regenerate yamlpp.ml.
make and check that the produced file is ok.
If that may help, make run launches a small local webserverAdd your new file in pages/. File name is up to you, but please
avoid strange ones. Files in pages/ will be pre-processed by Yamlpp
(see yamlpp-*/README for me details). Basically, to be uniform with
the other pages of the site, your file should look like:
<#def TITLE> your page title </#def> <#include "incl/header.html">
with your HTML code corresponding roughly to the inner of the HTML body:
<#include "incl/footer.html">
In addition, you could add just after the TITLE two other macro definitions:
<head> section<a href="https://github.com/coq/coq.github.io/blob/master/">Home</a>.Ensure that your page is built and installed. Normally, this should be automatic now. You could add multiple lines to have multiple aliases for the same page.
Nota: for pages converted from Drupal, the relevant part of the url is now a directory, in with we place an index.html. This approach is also recommended for new pages, but not mandatory.
make, verify, commit, push as for the edition of an existing page below.
Add a new file in news/ with the file name of your liking.
You can for instance copy news/template and adapt it, or any existing
news files. See news/template for details about the expected syntax.
In the file NEWSINDEX, add your news title (filename) at the top
(this list is sorted in chronological order, most recent first).
make, verify, commit, push as usual