Coder Social home page Coder Social logo

lysxia / coq-www Goto Github PK

View Code? Open in Web Editor NEW

This project forked from coq/coq.github.io

0.0 3.0 0.0 19.78 MB

Source files of the coq.inria.fr website (static part)

Home Page: https://coq.inria.fr/

Makefile 0.26% Nix 0.02% Coq 21.30% HTML 69.41% CSS 2.36% OCaml 6.65%

coq-www's Introduction

Coq website

This repository contains the static pages of the Coq website

make
make run

Pre-html sources are in pages/ and news/, while final html files will be assembled in dest/.

Prerequisites

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.

How to edit an existing page?

  • Edit the source file containing the webpage.
  • Run make and check that the produced file is ok. If that may help, make run launches a small local webserver
  • Commit your change and push it to the main repository The update of coq.inria.fr should then be automatic (TODO)

How to create a new page?

  • Add 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 : anything in it will be added at the end of the <head> section
    • PATH : some code displayed before the title of your page, usually a sequence of links to your page ancestors. See Drupal's breadcrumb. By default: <a href="/">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.

And for news?

  • 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 NEWS, add your news title (filename) at the top (this list is sorted in chronological order, most recent first).

  • make, verify, commit, push as usual

coq-www's People

Contributors

maximedenes avatar letouzey avatar ybertot avatar zimmi48 avatar herbelin avatar clarus avatar mattam82 avatar jnarboux avatar vbgl avatar achlipala avatar pirbo avatar amahboubi avatar psteckler avatar silene avatar aspiwack avatar strub avatar tchajed avatar cohencyril avatar gasche avatar jfehrle avatar mattjquinn avatar jacquev6 avatar william-lawvere avatar

Watchers

James Cloos avatar Xia Li-yao avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.