~cypheon/idris2-quickdocs

Fast Idris2 Doc Browser with Fuzzy Matching
12e9ed8c — Johann Rudloff 24 days ago
Escape "pipe" character when preparing the search regex
da9ea60f — Johann Rudloff a month ago
Remove local duplicate dev dir fallback value
c4b45519 — Johann Rudloff a month ago
Include docs for new "test" library

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~cypheon/idris2-quickdocs
read/write
git@git.sr.ht:~cypheon/idris2-quickdocs

You can also use your local clone with git send-email.

#Idris2 Quickdocs

This is an index generator and fast documentation browser for Idris2.

#Live Demo

A demo of this is hosted at https://idris2docs.sinyax.net

#Requirements

To generate the documentation index, you need Python 3, poetry and the mkdoc branch of my Idris2 fork (at least until the doc generation is ready to be upstreamed).

#Usage

Updating and serving the docs is a bit rought for now, but all the pieces are available.

Run poetry install to install dependencies, then you can run the following:

IDRIS2_EXECUTABLE=path/to/idris2 IDRIS2_SRC=path/to/idris2/source/code ./rebuild_all.sh

The you can serve the current directory (don't do this in production!):

python3 -mhttp.server 8001

And your docs will be served at http://127.0.0.1:8001/