does this support monorepo ?

[r17x]

Hi

does this support monorepo project ?

I have some project with structure like this

. (root)
|-> rescript-x
|-> rescript-y

and want to run bsdoc in root and generated documentation by each project (x,y).

Expected:

. (root)
|-> docs
|----> rescript-x
|----> rescript-y
|-> rescript-x
|-> rescript-y

OR

does this support for generate Markdown ?

Thank you

[yawaramin]

Hi, re: monorepo, I'll need to investigate that. Re: Markdown, no, only ocamldoc syntax is supported.

The bigger question though is are you using ReScript syntax? Because that's not supported. The ReScript team have their own documentation tooling plans, that tooling should be used for ReScript when available.

[r17x]

Hi @yawaramin .

Thank you for your response.

re: markdown support and re: monorepo Thank you

re: rescript syntax

Yes, I have been use in My ReScript project and it's work correctly for generated Types and Doc Comment on my project.

Before, I didn't know this project is not supported with ReScript syntax.

FYI, this is how I write comment and use bsdoc support for ReScript Syntax.

@@ocaml.text("   A [let binding], in other languages, might be called a [variable declaration]. let binds values to names. They can be seen and referenced by code that comes after them.

  @see <https://rescript-lang.org/docs/manual/latest/let-binding>
")