Skip to content
Discussions/App Development/Monospace in `damlc doc`Forum ↗

Monospace in `damlc doc`

App Development4 posts398 views10 likesLast activity May 2021
LU
LucianoOP
May 2021

Continuing the discussion from Haddock for daml?:

I’m following the haddock docs here, and can’t seem to get the monospace @abcd@ markup to work.

@Sofia_Faro said

This tool is still in development, there isn’t official documentation

What’s my best bet here? Should I be looking through the source code or is there somewhere else that I can figure out what features are supported?

CO
cocreature
May 2021

We don’t follow haddock syntax. Generally what we support is mostly a subset of markdown. So for monospace use

`abcd`
LU
Luciano
May 2021

So perhaps I was mislead by the linked post: are you saying that the doc generation is not based on haddock? Is it some other generator that I could read the documentation to get a better idea of what the features are? Or is it something we’ve written from scratch?

CO
cocreature
May 2021

We piggyback on haddock wtr to which comments are documentation vs which are regular documentation. We don’t use haddock for parsing a doc comment or generating the resulting documentation.

There isn’t any great documentation for this at the moment. daml-docs is still in labs status. Looking through the daml-stdlib documentation is probably your best option for figuring out what is possible.

← Back to Discussions