Merge pull request #239 from LuxDL/ap/citation_links

Author: lazarusA

.github/workflows/Documenter.yml

@@ -20,7 +20,7 @@ permissions:
   pages: write
   id-token: write
   statuses: write
-        
+
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
@@ -38,9 +38,6 @@ jobs:
         uses: julia-actions/setup-julia@v1
       - name: Pull Julia cache
         uses: julia-actions/cache@v1
-      - name: Install documentation dependencies
-        run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()'
-      #- name: Creating new mds from src
       - name: Build and deploy docs
         uses: julia-actions/julia-docdeploy@v1
         env:

Project.toml

@@ -1,7 +1,7 @@
 name = "DocumenterVitepress"
 uuid = "4710194d-e776-4893-9690-8d956a29c365"
 authors = ["Lazaro Alonso <[email protected]>", "Anshul Singhvi <[email protected]>"]
-version = "0.1.11"
+version = "0.1.12"
 
 [deps]
 ANSIColoredPrinters = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"

docs/Project.toml

@@ -2,3 +2,6 @@
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+
+[sources]
+DocumenterVitepress = { path = ".." }

docs/src/manual/citations.md

@@ -37,7 +37,6 @@ This is the default style (`style=:numeric`) used throughout the other pages of
 ```@bibliography
 Pages = [@__FILE__]
 Style = :numeric
-Canonical = false
 ```
 
 ## [Author-year style](@id author_year_style)

ext/DocumenterVitepressDocumenterCitationsExt.jl

@@ -3,37 +3,40 @@ module DocumenterVitepressDocumenterCitationsExt
 using DocumenterCitations, DocumenterVitepress
 
 import DocumenterVitepress as DV
-using Documenter: MarkdownAST
+using Documenter: Documenter, MarkdownAST
+using .MarkdownAST: @ast
 
-# TODO: 
+# TODO:
 # - List style (rendered vs unrendered)
 # - Loose vs tight lists
 # - 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
 function DV.render(io::IO, mime::MIME"text/plain", node::DV.MarkdownAST.Node, bibliography::DocumenterCitations.BibliographyNode, page, doc; kwargs...)
-
-    println(io)
-    println(io, "***")
-    println(io, "# Bibliography")
-    println(io)
-
     # Turn the list into a proper MarkdownAST.node
     bibnode = _bibliography_to_list(bibliography)
-
     return DV.render(io, mime, bibnode, bibnode.element, page, doc; kwargs...)
 end
 
 function _bibliography_to_list(bib::DocumenterCitations.BibliographyNode)
-  # Construct a MarkdownAST.Node containing this list
-  list = MarkdownAST.List(bib.list_style in [:ol, :dl] ? :ordered : :bullet, false)
-  node = MarkdownAST.Node(list)
-  for item in bib.items
-    newitem = MarkdownAST.Node(MarkdownAST.Item())
-    push!(newitem.children, item.reference)
-    push!(node.children, newitem)
-  end
-  node
+    # Construct a MarkdownAST.Node containing this list
+    list = MarkdownAST.List(bib.list_style in [:ol, :dl] ? :ordered : :bullet, false)
+    node = MarkdownAST.Node(list)
+    for item in bib.items
+        newitem = MarkdownAST.Node(MarkdownAST.Item())
+        reference = item.reference
+        if item.anchor_key !== nothing
+            pushfirst!(
+                reference.children,
+                @ast MarkdownAST.HTMLInline(
+                    join(["<a id='", item.anchor_key, "'></a>"])
+                )
+            )
+        end
+        push!(newitem.children, reference)
+        push!(node.children, newitem)
+    end
+    node
 end
 
 # Below is the code intended for LaTeXWriter.

src/writer.jl

@@ -965,6 +965,10 @@ function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Nod
         println.((io,), eachline)
     end
 end
+# HTMLInline
+function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Node, html::MarkdownAST.HTMLInline, page, doc; kwargs...)
+    println(io, html.html)
+end
 # Tables
 function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Node, table::MarkdownAST.TableCell, page, doc; kwargs...)
     println("Encountered table cell!")