mdoc icon indicating copy to clipboard operation
mdoc copied to clipboard

Support for Docusaurus 2.x

Open etspaceman opened this issue 4 years ago • 3 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.

etspaceman avatar Sep 03 '21 02:09 etspaceman

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

ckipp01 avatar Oct 05 '21 20:10 ckipp01

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 ?

benhutchison avatar Jun 05 '22 12:06 benhutchison

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.

limansky avatar Nov 29 '22 08:11 limansky