Don't hash links (#17)

* Don't hash links * be better * fix links finally * typo
LuxDL · Feb 18, 2024 · c0090b8 · c0090b8 · asinghvi17 · Feb 18, 2024
1 parent 6fe2857
commit c0090b8
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 15 deletions.
diff --git a/.github/workflows/Documenter.yml b/.github/workflows/Documenter.yml
@@ -48,12 +48,11 @@ jobs:
       - name: Instantiate NPM
         run: cd docs/; npm i; cd ..
       #- name: Creating new mds from src
-      - name: Build and deploy
+      - name: Build and deploy docs
+        uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-          GKSwstype: "100"
+          GKSwstype: "100" # for Plots.jl plots (if you have them)
           JULIA_DEBUG: "Documenter"
-          DATADEPS_ALWAYS_ACCEPT: true
-        run: |
-          julia --project=docs/ --color=yes docs/make.jl # this should ideally AUTO-DEPLOY!
+          DATADEPS_ALWAYS_ACCEPT: true
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -38,7 +38,7 @@ features:
 
 <p style="margin-bottom:2cm"></p>
 
-<div class="vp-doc" style="width:60%; margin:auto">
+<div class="vp-doc" style="width:80%; margin:auto">
 
 <h1> What is DocumenterVitepress.jl? </h1>
 

diff --git a/src/writer.jl b/src/writer.jl
@@ -378,7 +378,7 @@ end
 # Headers
 function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Node, header::Documenter.AnchoredHeader, page, doc; kwargs...)
     anchor = header.anchor
-    id = string(hash(Documenter.anchor_label(anchor)))
+    id = string(Documenter.anchor_label(anchor))
     # @infiltrate
     heading = first(node.children)
     println(io)
@@ -507,24 +507,24 @@ end
 
 # Documenter.jl page links
 function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Node, link::Documenter.PageLink, page, doc; kwargs...)
-    # @infiltrate
+    # Main.@infiltrate
    path = if !isempty(link.fragment)
-        string(hash(link.fragment))
+        replace(Documenter.pagekey(doc, link.page), ".md" => "") * "#" * string(link.fragment)
     else
-        Documenter.pagekey(io.doc, link.page)
+        Documenter.pagekey(doc, link.page)
     end
-    print(io, "<a href=\"$path\">")
+    print(io, "[")
     render(io, mime, node, node.children, page, doc; kwargs...)
-    print(io, "</a>")
+    print(io, "]($path)")
 end
 
 # Documenter.jl local links
 function render(io::IO, mime::MIME"text/plain", node::Documenter.MarkdownAST.Node, link::Documenter.LocalLink, page, doc; kwargs...)
     # @infiltrate
-    href = isempty(link.fragment) ? link.path : "$(link.path)#($(link.fragment))"
-    print(io, "<a href=\"$href\">")
+    path = isempty(link.fragment) ? link.path : "$(link.path)#$(link.fragment)"
+    print(io, "[")
     render(io, mime, node, node.children, page, doc; kwargs...)
-    print(io, "</a>")
+    print(io, "]($path)")
 end