package hockmd

Not available on OCaml 5.5
  1. Overview
  2. Docs
A library to access hackmd's api

Install

dune-project
 Dependency

Authors

Maintainers

Sources

hockmd-0.1.0.tbz
sha256=72215a2a33d7c6976995caccad8ea066c220156231956ef0d30b3fadcdd195b3
sha512=2085c1c85b01265237c9b587269f972632bc6c398d2fa72b8bba95fcf508a9fe8e1d73876b873852e068a912764ed6dc0a9cb5b5d4c0ab27b5ca6e15e47ce3f9

Description

A library to access hackmd's api

Added to opam-repository:

README

hockmd

An ocaml library to access the hackmd API.

Installation

Using Opam

opam install hockmd

Usage

The API of the library follows closely the one of the hackmd API.

You will need a token as explained here.

The library returns types enclosed in result and promises. It is advised to make use of ocaml syntax to avoid a too heavy syntax!

let token = "........."

let res =
    let++ notes = Hockmd.notes token in
    List.iter (fun note -> print_endline note.title) notes

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test

Optional Dependencies

None

Used by

None

Conflicts (1)

  1. result < "1.5"

Build status

Results of building hockmd with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.1.0 (this version) good good good n/a n/a
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure