r
/
bookshelf-doc
mirror of https://github.com/jrpotter/bookshelf-doc
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md 

Add notice on differences this fork introduces.
main
Joshua Potter 2023-12-14 17:14:04 -07:00 committed by GitHub
parent cda229ac12
commit d2db077fc4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,6 +1,18 @@
# `doc-gen4` # `doc-gen4`
Document Generator for Lean 4 Document Generator for Lean 4
---
***Disclaimer***: This fork is tightly coupled to my
[bookshelf](https://github.com/jrpotter/bookshelf) project. It makes the following
changes:
* Custom index page
* Script to convert LaTeX files into PDFs (using `pdflatex`)
* Modifications to show PDFs in the navbar
---
## Usage ## Usage
`doc-gen4` is the easiest to use via its custom Lake facet, in order `doc-gen4` is the easiest to use via its custom Lake facet, in order
to do this you have to add it to your `lakefile.lean` like this: to do this you have to add it to your `lakefile.lean` like this: