Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: first working version for DocumenterCitations #139

Merged
merged 9 commits into from
May 19, 2024

Conversation

thofma
Copy link
Contributor

@thofma thofma commented May 19, 2024

  • fix also the ordered list printing

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
Copy link
Collaborator

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
Copy link
Collaborator

I added a bit of documentation in thofma#1, but it doesn't seem to be rendering...

@thofma
Copy link
Contributor Author

thofma commented May 19, 2024

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

Add docs and minor code cleanups
@thofma
Copy link
Contributor Author

thofma commented May 19, 2024

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

@thofma
Copy link
Contributor Author

thofma commented May 19, 2024

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
Copy link
Collaborator

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
Copy link
Collaborator

asinghvi17 commented May 19, 2024

See the preview for #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.

src/vitepress_config.jl Outdated Show resolved Hide resolved
@thofma
Copy link
Contributor Author

thofma commented May 19, 2024

you have to ask the author of #117 :)

@asinghvi17
Copy link
Collaborator

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

Comment on lines +11 to +13
# - handle :dl properly, we cannot use Markdown for this, since it cannot be represented
# using pure Markdown. We need to insert HTML directly.
# At the moment, we treat :dl as :ol
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should be able to do that, I think Vitepress accepts pure HTML. I'm just not sure if the Markdown will still be picked up. We'll have to test but that can be done later.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

@asinghvi17
Copy link
Collaborator

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

@asinghvi17 asinghvi17 merged commit 1860fc2 into LuxDL:master May 19, 2024
1 check passed
@thofma thofma deleted the th/cite branch May 19, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants