"npx chappe build" on Windows gives wrong directory structure

crisp-oss / chappe

🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

https://www.npmjs.com/package/chappe

MIT License

206 stars 29 forks source link

"npx chappe build" on Windows gives wrong directory structure #8

Open BetTD opened 1 year ago

BetTD commented 1 year ago

Running npx chappe build on a Windows environment seems to be generating a weird directory structure: after a certain depth, the pre-rendered HTML files for each guide is stored under a subdirectory called index.md, as can be seen here: https://paste.sparked.host/umiboqehec.txt

Running the same command on Linux, against the same repository, yields the correct results as expected: https://paste.sparked.host/zutahoyapo.txt

valeriansaliou commented 1 year ago

Hello there!

Unfortunately, Chappe was not built for and tested for Windows. I also don't have any Windows platform to test it on.

I'd accept PRs for a fix. Thank you!

BetTD commented 1 year ago

Hm, I wonder how you guys test docs at Crisp...

Anyway, back to the point. It probably has to do with one of the many deprecated dependencies used by Chappe (possibly urix? it's a few levels deep in the dependency tree). Unfortunately, I don't have the time to try to fix this, so I'll see if running this under WSL yields different results.

valeriansaliou commented 1 year ago

We all run on macOS, on which everything works just fine, and then we build for production on Linux which also works fine.

Let me know if you find anything.