https://github.com/coq-community/coqdocjs

Collection of scripts to improve the output of coqdoc [maintainers=@chdoc,@palmskog]
https://github.com/coq-community/coqdocjs

coq coqdoc css html javascript

Last synced: 24 days ago
JSON representation

Collection of scripts to improve the output of coqdoc [maintainers=@chdoc,@palmskog]

• Host: GitHub
• URL: https://github.com/coq-community/coqdocjs
• Owner: coq-community
• License: bsd-2-clause
• Created: 2016-04-18T15:24:23.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T21:18:20.000Z (6 months ago)
• Last Synced: 2024-12-07T17:11:42.562Z (about 1 month ago)
• Topics: coq, coqdoc, css, html, javascript
• Language: JavaScript
• Homepage: https://www.ps.uni-saarland.de/~ttebbi/coqdocjs/
• Size: 34.2 KB
• Stars: 37
• Watchers: 6
• Forks: 17
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CoqdocJS

CoqdocJS is a little script to dynamically improve the coqdoc output.

The result can be seen here:

https://www.ps.uni-saarland.de/autosubst/doc/Ssr.POPLmark.html

It offers the following features:

- Customizable Unicode display:

	It only changes the display, copy-paste from the website produces pure ASCII.

	It only replaces complete identifiers or notation tokens, possibly terminated by numbers or apostrophes.

	It does not replace randomly, like in "omega." or "tauto."

	To add new symbols, edit [config.js](extra/resources/config.js).

- Proof hiding:

	All proofs longer than one line are hidden by default. They can be uncovered by clicking on "Proof...".

All of this works with the ordinary coqdoc, by asking coqdoc to use a header file including the javascript files and some custom CSS.

## Usage

1. Clone this repository as a subdirectory or submodule;

2. Include [Makefile.doc] in your `Makefile`, or copy it as, e.g., `Makefile.coq.local`;

3. Run `make coqdoc` to build documentations.

A minimal example is shown [here](example).

### Environment Variables

Name | Usage | Default

---|---|---

`COQDOCFLAGS` | Override the flags passed to `coqdoc` | see [Makefile.doc]

`COQDOCEXTRAFLAGS` | Extend the flags passed to `coqdoc` | empty

`COQDOCJS_LN` | If set to `true` then symlink resource files; otherwise copy | `false`

`COQDOCJS_DIR` | Folder containing CoqdocJS | `coqdocjs`

`COQMAKEFILE` | Makefile generated by `coq_makefile` | `Makefile.coq`

## Files

- [Makefile.doc]: a generic Makefile setup that calls coqc and coqdoc with the right parameters

- [config.js](extra/resources/config.js): contains the unicode replacement table

- [coqdoc.css](extra/resources/coqdoc.css): a replacement for the default Coqdoc CSS style. Can be removed to use the default style

- [coqdocjs.js](extra/resources/coqdocjs.js) and [coqdocjs.css](extra/resources/coqdocjs.css): the script rewriting the DOM and adding the dynamic features with a corresponding CSS style

- [header.html](extra/header.html) and [footer.html](extra/footer.html): custom header and footer files used in every generated html file

[Makefile.doc]: Makefile.doc