LuxDL / DocumenterVitepress.jl

Documentation with Documenter.jl and VitePress
https://luxdl.github.io/DocumenterVitepress.jl/
MIT License
73 stars 11 forks source link

feat: first working version for DocumenterCitations #139

Closed thofma closed 4 months ago

thofma commented 4 months ago

Builds upon #117

There are still (lots) of todos, but this seems to be working. I would suggest to get this in.

Edit: Tagging a version containing this would be appreciated. Then I can test it a bit more in the wild.

lazarusA commented 4 months ago

it would be good to have at least a very simple example in https://luxdl.github.io/DocumenterVitepress.jl/dev/code_example or where appropriate. As it is, I cannot see how it would look like.

asinghvi17 commented 4 months ago

I added a bit of documentation in https://github.com/thofma/DocumenterVitepress.jl/pull/1, but it doesn't seem to be rendering...

thofma commented 4 months ago

This is just the backend (writer), so all I could do is copy verbatim what is written here: https://github.com/JuliaDocs/DocumenterCitations.jl?tab=readme-ov-file#usage

thofma commented 4 months ago

thanks @asinghvi17 (I also would not mind if you push directly, which you should be able to)

thofma commented 4 months ago

It is still kind of broken: https://github.com/LuxDL/DocumenterVitepress.jl/actions/runs/9146691992/job/25147180913?pr=139#step:6:116

But it seems to work for me locally (for my own repo, not this one here).

asinghvi17 commented 4 months ago

Ah I forgot this is an external PR...yeah I saw those locally as well, I'm not sure where they're coming from though.

asinghvi17 commented 4 months ago

See the preview for https://github.com/LuxDL/DocumenterVitepress.jl/pull/140, this seems to be working online (but not locally for me somehow).

There is an issue with the navbar/sidebar printing though, probably related to the change made here.

thofma commented 4 months ago

you have to ask the author of https://github.com/LuxDL/DocumenterVitepress.jl/pull/117 :)

asinghvi17 commented 4 months ago

You can tell it's been a while since that PR 😄 - I guess we should remove it then!

asinghvi17 commented 4 months ago

Waiting to inspect the preview in #140, then will merge! Thanks for the effort @thofma!