scalameta / mdoc

Typechecked markdown documentation for Scala

Home Page:https://scalameta.org/mdoc/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Support for Docusaurus 2.x

etspaceman opened this issue · comments

Seems that Docusaurus changed the deploy command in the 2.x series:

https://docusaurus.io/docs/deployment#deploy

It would be great if this plugin could handle both implementations. Running it for sites generated in Docusaurus 2.x yields this error:

error Command "publish-gh-pages" not found.

Btw this should already work, but will require some effort to ensure that everything is migrated correctly For example I'm pretty sure the issue you are seeing is because the commands need to be updated in your package.json to the new deploy ones. For example we use Docusaurus 2.x in Metals via mdoc. You can see the changes we need to make this happen here: https://github.com/scalameta/metals/pull/2927/files

Also, as I just discovered, the current Mdoc docs for Docusaurus no longer work, because the instructions are for v1, but the link goes to v2.

As a short term measure, perhaps direct users to https://v1.docusaurus.io/docs/en/installation rather than https://docusaurus.io/
so they at least get a working site ?

Hi,

If somebody interested, we are using docusaurus 2.2 in https://github.com/rusexpertiza-llc/yupana/

To make it work I just added command allias "publish-gh-pages": "docusaurus deploy" in package.json. However, I think it would be nice to have setting deployCommand in mdoc.