LuxDL / DocumenterVitepress.jl

Documentation with Documenter.jl and VitePress

https://luxdl.github.io/DocumenterVitepress.jl/

MIT License

64 stars 9 forks source link

Instructions in readme produce a website with broken formatting #29

Closed LilithHafner closed 4 months ago

LilithHafner commented 4 months ago

The readme instructions are appealingly minimal. I tried them out on this PR to Chairmarks.jl, but found the result to have broken formatting. Ideally (and aspirationally), those incredibly simple instructions would produce a website of a similar quality as https://luxdl.github.io/DocumenterVitepress.jl/dev/. In the interim, it would be appropriate to only provide instructions that are complete enough to produce a website with functional formatting.

asinghvi17 commented 4 months ago

28 should fix that significantly.

asinghvi17 commented 4 months ago

That being said, because the navbar and sidebar are determined in config.mts, we should probably come to a decision as to whether to hook those into Documenter or tell users to do it themselves, basically

asinghvi17 commented 4 months ago

I just updated a bunch of stuff including the README - how does it look now @LilithHafner?

LilithHafner commented 4 months ago

Sorry about the delay. I tried again and it is unfortunately, still not working for me (https://github.com/LilithHafner/Chairmarks.jl/pull/35)

In addition to the readme instructions I need to add a package.json file for docs to build
Even after doing this they are not formatted.

LilithHafner commented 4 months ago

I did still need to copy docs/package.json from this repo in https://github.com/LilithHafner/Chairmarks.jl/pull/35, which is not a step listed on the readme.