Merge pull request #48 from JuliaComputing/sp/rootpath-

feature: add rootpath arg

Author: pfitzseb

assets/default/flexsearch_integration.js

@@ -20,9 +20,10 @@
         input.setAttribute('placeholder', 'Loading...')
         successfullyLoadedIndex = false
         const keys = ['content.cfg', 'content.ctx', 'content.map', 'reg', 'store']
+        const rootPath = window.MULTIDOCUMENTER_ROOT_PATH ?? '/'
         const promises = keys.map(key => {
             return new Promise((resolve, reject) => {
-                fetch('/search-data/' + key + '.json').then(r => {
+                fetch(`${rootPath}search-data/${key}.json`).then(r => {
                     if (r && r.ok) {
                         r.json().then(idx => {
                             flexsearchIdx.import(key, idx)

docs/make.jl

@@ -65,7 +65,8 @@ MultiDocumenter.make(
     search_engine = MultiDocumenter.SearchConfig(
         index_versions = ["stable"],
         engine = MultiDocumenter.FlexSearch
-    )
+    ),
+    rootpath = "/MultiDocumenter.jl/",
 )
 
 gitroot = normpath(joinpath(@__DIR__, ".."))

src/MultiDocumenter.jl

@@ -63,7 +63,8 @@ function walk_outputs(f, root, docs::Vector{MultiDocRef}, dirs::Vector{String})
                 for file in files
                     file == "index.html" || continue
 
-                    f(chop(r, head = length(root), tail = 0), joinpath(r, file))
+                    # +1 for path separator
+                    f(chop(r, head = length(root) + 1, tail = 0), joinpath(r, file))
                 end
             end
             break
@@ -86,7 +87,8 @@ const DEFAULT_ENGINE = SearchConfig(index_versions = ["stable", "dev"], engine =
         custom_stylesheets = [],
         custom_scripts = [],
         search_engine = SearchConfig(),
-        prettyurls = true
+        prettyurls = true,
+        rootpath = "/"
     )
 
 Aggregates multiple Documenter.jl-based documentation pages `docs` into `outdir`.
@@ -99,6 +101,7 @@ Aggregates multiple Documenter.jl-based documentation pages `docs` into `outdir`
   `Docs.HTML` objects are inserted as the content of inline scripts.
 - `search_engine` inserts a global search bar if not `false`. See [`SearchConfig`](@ref) for more details.
 - `prettyurls` removes all `index.html` suffixes from links in the global navigation.
+-`rootpath` is the path your site ends up being deployed at, e.g. `/foo/` if it's hosted at `https://bar.com/foo`
 """
 function make(
     outdir,
@@ -109,6 +112,7 @@ function make(
     custom_scripts = [],
     search_engine = DEFAULT_ENGINE,
     prettyurls = true,
+    rootpath = "/",
 )
     maybe_clone(flatten_multidocrefs(docs))
 
@@ -135,10 +139,11 @@ function make(
         custom_scripts,
         search_engine,
         prettyurls,
+        rootpath,
     )
 
     if search_engine != false
-        search_engine.engine.build_search_index(dir, flatten_multidocrefs(docs), search_engine)
+        search_engine.engine.build_search_index(dir, flatten_multidocrefs(docs), search_engine, rootpath)
     end
 
     cp(dir, outdir; force = true)
@@ -300,10 +305,11 @@ function inject_styles_and_global_navigation(
     custom_scripts,
     search_engine,
     prettyurls,
+    rootpath,
 )
 
     if search_engine != false
-        search_engine.engine.inject_script!(custom_scripts)
+        search_engine.engine.inject_script!(custom_scripts, rootpath)
         search_engine.engine.inject_styles!(custom_stylesheets)
     end
     pushfirst!(custom_stylesheets, joinpath("assets", "default", "multidoc.css"))

src/search/flexsearch.jl

@@ -84,18 +84,20 @@ function add_to_index!(index, ref, file)
     push!(index.documents, doc)
 end
 
-function generate_index(root, docs, config)
+function generate_index(root, docs, config, rootpath)
     search_index = SearchIndex()
     walk_outputs(root, docs, config.index_versions) do path, file
-        add_to_index!(search_index, path, file)
+        ref = replace(joinpath(rootpath, path), raw"\\" => "/")
+        add_to_index!(search_index, ref, file)
     end
 
     return search_index
 end
 
-function inject_script!(custom_scripts)
+function inject_script!(custom_scripts, rootpath)
     pushfirst!(custom_scripts, joinpath("assets", "default", "flexsearch_integration.js"))
     pushfirst!(custom_scripts, joinpath("assets", "default", "flexsearch.bundle.js"))
+    pushfirst!(custom_scripts, Docs.HTML("window.MULTIDOCUMENTER_ROOT_PATH = '$(rootpath)'"))
 end
 
 function inject_styles!(custom_styles)
@@ -139,9 +141,9 @@ function to_json_index(index::SearchIndex, file)
     end
 end
 
-function build_search_index(root, docs, config)
+function build_search_index(root, docs, config, rootpath)
     ID[] = 0
-    idx = generate_index(root, docs, config)
+    idx = generate_index(root, docs, config, rootpath)
     to_json_index(idx, joinpath(root, "index.json"))
     file = config.lowfi ? "gensearch-lowfi.js" : "gensearch.js"
     println("Writing $(config.lowfi ? "lowfi" : "") flexsearch index:")

src/search/stork.jl

@@ -14,7 +14,7 @@ function has_stork()
     return has_stork
 end
 
-function build_search_index(root, docs, config)
+function build_search_index(root, docs, config, _)
     config = make_stork_config(root, docs, config)
     config_path = joinpath(root, "stork.config.toml")
     index_path = joinpath(root, "stork.st")
@@ -61,7 +61,7 @@ function add_to_index!(files, ref, path)
     return
 end
 
-function inject_script!(custom_scripts)
+function inject_script!(custom_scripts, _)
     pushfirst!(custom_scripts, joinpath("assets", "default", "stork.js"))
     pushfirst!(custom_scripts, joinpath("assets", "default", "stork_integration.js"))
 end

test/runtests.jl

@@ -67,6 +67,8 @@ using Test
 
     outpath = joinpath(@__DIR__, "out")
 
+    rootpath = "/MultiDocumenter.jl/"
+
     MultiDocumenter.make(
         outpath,
         docs;
@@ -78,7 +80,8 @@ using Test
             "foo/bar.js",
             "https://foo.com/bar.js",
             Docs.HTML("const foo = 'bar';")
-        ]
+        ],
+        rootpath = rootpath,
     )
 
     @testset "structure" begin
@@ -96,6 +99,7 @@ using Test
     @testset "custom scripts" begin
         index = read(joinpath(outpath, "inf", "stable", "index.html"), String)
 
+        @test occursin("""<script charset="utf-8" type="text/javascript">window.MULTIDOCUMENTER_ROOT_PATH = '$rootpath'</script>""", index)
         @test occursin("""<script charset="utf-8" src="../../foo/bar.js" type="text/javascript"></script>""", index)
         @test occursin("""<script charset="utf-8" src="https://foo.com/bar.js" type="text/javascript"></script>""", index)
         @test occursin("""<script charset="utf-8" type="text/javascript">const foo = 'bar';</script>""", index)
@@ -107,7 +111,8 @@ using Test
         @test !isempty(store_content)
         @test occursin("Infiltrator.jl", store_content)
         @test occursin("@infiltrate", store_content)
-        @test occursin("/inf/stable/", store_content)
+        @test occursin("$(rootpath)inf/stable/", store_content)
+        @test occursin("$(rootpath)inf/stable/", store_content)
         @test !occursin("/inf/dev/", store_content)
     end