# \#documenter

**URL:** https://discourse.julialang.org/tag/documenter/59.md

[Latest](https://discourse.julialang.org/latest.md) · [Categories](https://discourse.julialang.org/categories.md) · [Tags](https://discourse.julialang.org/tags.md)

---

## [\[ANN\] DocumenterLandingPage.jl, a VitePress-style landing page for Documenter.jl](https://discourse.julialang.org/t/ann-documenterlandingpage-jl-a-vitepress-style-landing-page-for-documenter-jl/138819)

<div class="topic-metadata">

**Author:** [@csvance](https://discourse.julialang.org/u/csvance)\
**Replies:** 14\
**Last updated:** [September 22, 2026, 6:57pm UTC](https://discourse.julialang.org/t/ann-documenterlandingpage-jl-a-vitepress-style-landing-page-for-documenter-jl/138819 "2026-09-22T18:57:56Z")

</div>

I am happy to share DocumenterLandingPage.jl, a small Documenter.jl plugin that renders a VitePress-style landing page (hero plus emoji feature tiles) straight from the YAML frontmatter block a page carries in a @raw htm…

---

## [\[ANN\] MaterialDocs.jl - A Documenter.jl writer plugin that generates Material Design 3 documentation sites](https://discourse.julialang.org/t/ann-materialdocs-jl-a-documenter-jl-writer-plugin-that-generates-material-design-3-documentation-sites/139581)

<div class="topic-metadata">

**Author:** [@mthelm85](https://discourse.julialang.org/u/mthelm85)\
**Replies:** 6\
**Last updated:** [September 22, 2026, 4:30pm UTC](https://discourse.julialang.org/t/ann-materialdocs-jl-a-documenter-jl-writer-plugin-that-generates-material-design-3-documentation-sites/139581 "2026-09-22T16:30:37Z")

</div>

Hello! MaterialDocs.jl is a Documenter.jl writer for folks who want a modern docs site, but don’t want to change how their docs are built or deployed. Simply add it to your docs environment, replace Documenter.HTML(...) …

---

## [Adding the package to its workspaces](https://discourse.julialang.org/t/adding-the-package-to-its-workspaces/139331)

<div class="topic-metadata">

**Author:** [@Gregstrq](https://discourse.julialang.org/u/Gregstrq)\
**Replies:** 13\
**Last updated:** [September 10, 2026, 2:43pm UTC](https://discourse.julialang.org/t/adding-the-package-to-its-workspaces/139331 "2026-09-10T14:43:44Z")

</div>

I am looking into the workspaces feature, but have trouble understanding what is the correct way to add the package to its workspace einvironment: dev or add. For example, in the Pkg.jl manual, it is suggested to add th…

---

## [DocumenterCodeBlocks.jl announcement](https://discourse.julialang.org/t/documentercodeblocks-jl-announcement/138552)

<div class="topic-metadata">

**Author:** [@fredrikekre](https://discourse.julialang.org/u/fredrikekre)\
**Replies:** 25\
**Last updated:** [September 8, 2026, 4:36pm UTC](https://discourse.julialang.org/t/documentercodeblocks-jl-announcement/138552 "2026-09-08T16:36:01Z")

</div>

I want to to announce DocumenterCodeBlocks.jl, a Documenter.jl plugin that makes the code blocks in your package documentation quite a bit more interesting. To enable it the only thing you have to change is to pass the C…

---

## [\[ANN\] DocumenterCitations 1.5.0](https://discourse.julialang.org/t/ann-documentercitations-1-5-0/138904)

<div class="topic-metadata">

**Author:** [@goerz](https://discourse.julialang.org/u/goerz)\
**Replies:** 1\
**Last updated:** [August 26, 2026, 12:48pm UTC](https://discourse.julialang.org/t/ann-documentercitations-1-5-0/138904 "2026-08-26T12:48:27Z")

</div>

DocumenterCitations.jl has been released in version v1.5.0. See the Release Notes. This is the first feature release in almost exactly a year, and includes some features that have long been on the wishlist, and that Cla…

---

## [Documenter.jl and collapsible Markdown?](https://discourse.julialang.org/t/documenter-jl-and-collapsible-markdown/50898)

<div class="topic-metadata">

**Author:** [@uwechsler](https://discourse.julialang.org/u/uwechsler)\
**Replies:** 4\
**Last updated:** [July 16, 2026, 2:15pm UTC](https://discourse.julialang.org/t/documenter-jl-and-collapsible-markdown/50898 "2026-07-16T14:15:52Z")

</div>

Is it possible to have collapsible markdown elements in a documentation page (or even the navigation bar) created with Documenter? Here is an example: https://gist.github.com/joyrexus/16041f2426450e73f5df9391f7f7ae5f

---

## [Arbitrary anchor in Documenter](https://discourse.julialang.org/t/arbitrary-anchor-in-documenter/126311)

<div class="topic-metadata">

**Author:** [@moble](https://discourse.julialang.org/u/moble)\
**Replies:** 2\
**Last updated:** [July 7, 2026, 9:38am UTC](https://discourse.julialang.org/t/arbitrary-anchor-in-documenter/126311 "2026-07-07T09:38:14Z")

</div>

The Documenter docs show how it’s possible to explicitly name a header with something like # \[Header\](@id my\_custom\_header\_name) which can then be linked to in the documentation with something like \[Custom Header\](@re…

---

## [Documenter.jl doctest does not apply filter as expected](https://discourse.julialang.org/t/documenter-jl-doctest-does-not-apply-filter-as-expected/136706)

<div class="topic-metadata">

**Author:** [@phx](https://discourse.julialang.org/u/phx)\
**Replies:** 4\
**Last updated:** [April 16, 2026, 9:57am UTC](https://discourse.julialang.org/t/documenter-jl-doctest-does-not-apply-filter-as-expected/136706 "2026-04-16T09:57:45Z")

</div>

Hi all, I am writing the documentation for a package of mine, and in a doctest I have this output: 11-element Vector{ComplexF64}: 0.0 + 0.0im -1.617576049847552e-6 + 6.617439891157473e-23im -…

---

## [Documenter.jl cumbersome experience](https://discourse.julialang.org/t/documenter-jl-cumbersome-experience/136552)

<div class="topic-metadata">

**Author:** [@lilachint](https://discourse.julialang.org/u/lilachint)\
**Replies:** 6\
**Last updated:** [April 4, 2026, 1:05pm UTC](https://discourse.julialang.org/t/documenter-jl-cumbersome-experience/136552 "2026-04-04T13:05:25Z")

</div>

Hi! I’m a new user to Julia that wish to develop some packages. However, when it comes to documentation generation, I find it quite cumbersome. To be specific, I’m a lazy-ish person, and would try to generate documentat…

---

## [Documenter.jl: Running external commands asynchronously in \`@example\` blocks](https://discourse.julialang.org/t/documenter-jl-running-external-commands-asynchronously-in-example-blocks/135085)

<div class="topic-metadata">

**Author:** [@klafyvel](https://discourse.julialang.org/u/klafyvel)\
**Replies:** 1\
**Last updated:** [January 18, 2026, 4:16pm UTC](https://discourse.julialang.org/t/documenter-jl-running-external-commands-asynchronously-in-example-blocks/135085 "2026-01-18T16:16:15Z")

</div>

Hello, I am trying to run the following @example block in a Documenter page: pinocchio = PipeBuffer() listener = run(\`go-sendxmpp -n -p plopiplop -u pinocchio@localhost -l\`, devnull, pinocchio, stderr, wait = false) Bu…

---

## [Documenter.jl and markdown headings in docstrings](https://discourse.julialang.org/t/documenter-jl-and-markdown-headings-in-docstrings/135094)

<div class="topic-metadata">

**Author:** [@alametti](https://discourse.julialang.org/u/alametti)\
**Replies:** 2\
**Last updated:** [January 16, 2026, 5:04pm UTC](https://discourse.julialang.org/t/documenter-jl-and-markdown-headings-in-docstrings/135094 "2026-01-16T17:04:23Z")

</div>

Apologies as I am new to Julia and still trying to wrap my head around Julia’s documentation style (avoiding argument lists and expected output, etc). The Julia documentation recommends the use of markdown headings in f…

---

## [\[ANN\] PkgTemplatesShikiPlugin.jl - Add ShikiStyle Syntax Highlighting (Presenting at JuliaLang Japan 2025, Dec 13)](https://discourse.julialang.org/t/ann-pkgtemplatesshikiplugin-jl-add-shikistyle-syntax-highlighting-presenting-at-julialang-japan-2025-dec-13/134487)

<div class="topic-metadata">

**Author:** [@Hiroharu\_Sugawara](https://discourse.julialang.org/u/Hiroharu_Sugawara)\
**Replies:** 1\
**Last updated:** [December 11, 2025, 3:55am UTC](https://discourse.julialang.org/t/ann-pkgtemplatesshikiplugin-jl-add-shikistyle-syntax-highlighting-presenting-at-julialang-japan-2025-dec-13/134487 "2025-12-11T03:55:21Z")

</div>

I’m excited to announce PkgTemplatesShikiPlugin.jl! :tada: This plugin makes it easy to add beautiful, VS Code-quality syntax highlighting to your Julia package documentation. TL;DR - Try it now! using PkgTemplates, Pk…

---

## [Documenter build fails on CI with "OpenSSL\_jll … not installed" error](https://discourse.julialang.org/t/documenter-build-fails-on-ci-with-openssl-jll-not-installed-error/133505)

<div class="topic-metadata">

**Author:** [@Xing\_Shi\_Cai](https://discourse.julialang.org/u/Xing_Shi_Cai)\
**Replies:** 1\
**Last updated:** [October 29, 2025, 12:21pm UTC](https://discourse.julialang.org/t/documenter-build-fails-on-ci-with-openssl-jll-not-installed-error/133505 "2025-10-29T12:21:12Z")

</div>

Hi all — '’m hitting a puzzling failure building docs on Julia 1.12 where stdlib JLLs fail to load during precompilation. It happens in GitLab CI. Here’s the error julia --project=docs -e 'using Pkg; Pkg.develop(Packa…

---

## [Using @ref with explicit signatures](https://discourse.julialang.org/t/using-ref-with-explicit-signatures/133444)

<div class="topic-metadata">

**Author:** [@andreasvarga](https://discourse.julialang.org/u/andreasvarga)\
**Replies:** 6\
**Last updated:** [October 27, 2025, 1:25pm UTC](https://discourse.julialang.org/t/using-ref-with-explicit-signatures/133444 "2025-10-27T13:25:12Z")

</div>

In the FaultDetectionTools package I have two functions called emmsyn with the distinct signatures: julia\> methods(emmsyn) # 2 methods for generic function "emmsyn" from FaultDetectionTools: \[1\] emmsyn(sysf::FDIModel{…

---

## [Deploy Documenter docs locally](https://discourse.julialang.org/t/deploy-documenter-docs-locally/5463)

<div class="topic-metadata">

**Author:** [@baggepinnen](https://discourse.julialang.org/u/baggepinnen)\
**Replies:** 6\
**Last updated:** [September 24, 2025, 9:09pm UTC](https://discourse.julialang.org/t/deploy-documenter-docs-locally/5463 "2025-09-24T21:09:28Z")

</div>

As I understand it, the function deploydocs in Documenter.jl is designed to work with travis only. I have a private repository I would like to generate documentation for, and would like a deploydocs function that could d…

---

## [Cannot convert DocStr in Julia 1.11](https://discourse.julialang.org/t/cannot-convert-docstr-in-julia-1-11/131172)

<div class="topic-metadata">

**Author:** [@Kirby\_Zhang](https://discourse.julialang.org/u/Kirby_Zhang)\
**Replies:** 1\
**Last updated:** [July 29, 2025, 9:29pm UTC](https://discourse.julialang.org/t/cannot-convert-docstr-in-julia-1-11/131172 "2025-07-29T21:29:03Z")

</div>

This only happens in Julia 1.11 and only before REPL is loaded: method comments require \_\_init\_\_: Test Failed at K:\\DevDocuments\\Raven\_Inherit\\test\\PkgTest1\\test\\runtests.jl:45 Expression: strip(string(#= K:\\DevDocume…

---

## [DocumenterVitepress examples (list of packages that use it)](https://discourse.julialang.org/t/documentervitepress-examples-list-of-packages-that-use-it/130795)

<div class="topic-metadata">

**Author:** [@digital\_carver](https://discourse.julialang.org/u/digital_carver)\
**Replies:** 5\
**Last updated:** [July 23, 2025, 11:32am UTC](https://discourse.julialang.org/t/documentervitepress-examples-list-of-packages-that-use-it/130795 "2025-07-23T11:32:07Z")

</div>

I made an appreciation post for DocumenterVitepress on Slack a couple of months ago, and several people shared examples of docs generated using it in the replies. (For context, DocumenterVitepress is a special backend fo…

---

## [Documenter "undefined binding" error](https://discourse.julialang.org/t/documenter-undefined-binding-error/129475)

<div class="topic-metadata">

**Author:** [@Marco-Congedo](https://discourse.julialang.org/u/Marco-Congedo)\
**Replies:** 2\
**Last updated:** [May 30, 2025, 6:03pm UTC](https://discourse.julialang.org/t/documenter-undefined-binding-error/129475 "2025-05-30T18:03:04Z")

</div>

I implemented a new function sumOfSqrDiff in package PosDefManifold.jl. I have exported it and added the doc string, but when i build the documentation i have the error here below. I don’t see what’s wrong and the sol…

---

## [\[ANN\] DocumenterVitepress 0.2 with breaking changes](https://discourse.julialang.org/t/ann-documentervitepress-0-2-with-breaking-changes/128989)

<div class="topic-metadata">

**Author:** [@jules](https://discourse.julialang.org/u/jules)\
**Replies:** 0\
**Last updated:** [May 14, 2025, 9:32am UTC](https://discourse.julialang.org/t/ann-documentervitepress-0-2-with-breaking-changes/128989 "2025-05-14T09:32:48Z")

</div>

I have just released DocumenterVitepress 0.2 which is breaking, so your docs workflows will break unless you have compat set to 0.1. Many people don’t have compat settings in their docs/Project.toml (myself included) so …

---

## [Documenter.jl: HTMLWriter: rendering HTML pages loops forever](https://discourse.julialang.org/t/documenter-jl-htmlwriter-rendering-html-pages-loops-forever/128910)

<div class="topic-metadata">

**Author:** [@Marco-Congedo](https://discourse.julialang.org/u/Marco-Congedo)\
**Replies:** 4\
**Last updated:** [May 13, 2025, 2:39am UTC](https://discourse.julialang.org/t/documenter-jl-htmlwriter-rendering-html-pages-loops-forever/128910 "2025-05-13T02:39:26Z")

</div>

Hello everybody, I am updating a package after a long time and the documentation does not build anymore. Specifically, invoking the building process with makedocs, it gets to the final step, the REPL print HTMLWriter:…

---

## [Documenter.jl: How to avoid repetitions of shared docstrings?](https://discourse.julialang.org/t/documenter-jl-how-to-avoid-repetitions-of-shared-docstrings/128885)

<div class="topic-metadata">

**Author:** [@matthias314](https://discourse.julialang.org/u/matthias314)\
**Replies:** 11\
**Last updated:** [May 11, 2025, 8:30pm UTC](https://discourse.julialang.org/t/documenter-jl-how-to-avoid-repetitions-of-shared-docstrings/128885 "2025-05-11T20:30:35Z")

</div>

Suppose I have two functions that share a common docstring: f() = 1 g() = 2 "docstring for \`f\` and \`g\`" f, g I only want to the docstring to appear once in the documentation, not twice. However, if I only write \`\`\`@d…

---

## [Wrong Package Used in Documenter](https://discourse.julialang.org/t/wrong-package-used-in-documenter/128629)

<div class="topic-metadata">

**Author:** [@RainerHeintzmann](https://discourse.julialang.org/u/RainerHeintzmann)\
**Replies:** 11\
**Last updated:** [May 9, 2025, 7:59am UTC](https://discourse.julialang.org/t/wrong-package-used-in-documenter/128629 "2025-05-09T07:59:14Z")

</div>

I was trying in vain to get a documention for TiledViews.jl up and running. The issue is that the CI seems to install the last release version, rather than using the local Development Version, which is why the Documente…

---

## [Deploying docs error - OPENSSL version missmatch](https://discourse.julialang.org/t/deploying-docs-error-openssl-version-missmatch/128734)

<div class="topic-metadata">

**Author:** [@aris](https://discourse.julialang.org/u/aris)\
**Replies:** 1\
**Last updated:** [May 5, 2025, 8:58pm UTC](https://discourse.julialang.org/t/deploying-docs-error-openssl-version-missmatch/128734 "2025-05-05T20:58:25Z")

</div>

Hello everyone, Until recently, pushing a commit to my package would deploy the documentation without any issues, following these actions. Today, after pushing some changes, I got the following errors: ▶ Build and Depl…

---

## [\[ANN\] Documenter 1.9 - public keyword support](https://discourse.julialang.org/t/ann-documenter-1-9-public-keyword-support/127021)

<div class="topic-metadata">

**Author:** [@mortenpi](https://discourse.julialang.org/u/mortenpi)\
**Replies:** 3\
**Last updated:** [March 17, 2025, 10:55pm UTC](https://discourse.julialang.org/t/ann-documenter-1-9-public-keyword-support/127021 "2025-03-17T22:55:26Z")

</div>

I am happy to announce Documenter 1.9.0! As is often the case, there’s a bunch of changes in this release, and please see the release notes for full details. As always, thank you to everyone who contributed! However, on…

---

## [Versions of the documentation with Documenter.jl](https://discourse.julialang.org/t/versions-of-the-documentation-with-documenter-jl/126548)

<div class="topic-metadata">

**Author:** [@ufechner7](https://discourse.julialang.org/u/ufechner7)\
**Replies:** 2\
**Last updated:** [March 5, 2025, 6:36am UTC](https://discourse.julialang.org/t/versions-of-the-documentation-with-documenter-jl/126548 "2025-03-05T06:36:26Z")

</div>

We made several new releases of our package VortexStepMethod.jl , but they do not appear in the menu of the documentation. See: Since v0.1 we also released 1.0 and 1.0.1 and 1.1. Any idea how to make new versions ap…

---

## [Incremental Documentation.jl](https://discourse.julialang.org/t/incremental-documentation-jl/126539)

<div class="topic-metadata">

**Author:** [@bernardofpc](https://discourse.julialang.org/u/bernardofpc)\
**Replies:** 0\
**Last updated:** [March 4, 2025, 6:34pm UTC](https://discourse.julialang.org/t/incremental-documentation-jl/126539 "2025-03-04T18:34:30Z")

</div>

In a relatively large project, the documentation itself can be very large. Is there any Makefile-like mechanism to have “incremental compilation” of docs/src so that only files that have been touched (and their dependen…

---

## [How to document a struct with two constructors?](https://discourse.julialang.org/t/how-to-document-a-struct-with-two-constructors/126453)

<div class="topic-metadata">

**Author:** [@ufechner7](https://discourse.julialang.org/u/ufechner7)\
**Replies:** 1\
**Last updated:** [March 1, 2025, 3:04pm UTC](https://discourse.julialang.org/t/how-to-document-a-struct-with-two-constructors/126453 "2025-03-01T15:04:05Z")

</div>

using Parameters, StaticArrays const MVec3 = MVector{3, Float64} """ Section Represents a wing section with leading edge, trailing edge, and aerodynamic properties. # Fields - \`LE\_point::MVec3\` = zeros(MVec3):…

---

## [Filtering private API](https://discourse.julialang.org/t/filtering-private-api/126349)

<div class="topic-metadata">

**Author:** [@s\_amap](https://discourse.julialang.org/u/s_amap)\
**Replies:** 1\
**Last updated:** [February 27, 2025, 9:54am UTC](https://discourse.julialang.org/t/filtering-private-api/126349 "2025-02-27T09:54:55Z")

</div>

A bit of a naive question regarding documenter indexing : I have a package with a public API, and some internal developer functions that are mostly of no interest to users, with a few potential exceptions for power user…

---

## [How to link to a type definition?](https://discourse.julialang.org/t/how-to-link-to-a-type-definition/126332)

<div class="topic-metadata">

**Author:** [@ufechner7](https://discourse.julialang.org/u/ufechner7)\
**Replies:** 2\
**Last updated:** [February 26, 2025, 9:53pm UTC](https://discourse.julialang.org/t/how-to-link-to-a-type-definition/126332 "2025-02-26T21:53:18Z")

</div>

How can I link to a type definition in a docstring? Not working: """ calculate\_AIC\_matrices!(body\_aero::BodyAerodynamics, model::\[Model\](@ref), core\_radius\_fraction::Float64, …

---

## [Display docstring for extension method in documentation](https://discourse.julialang.org/t/display-docstring-for-extension-method-in-documentation/99720)

<div class="topic-metadata">

**Author:** [@gdalle](https://discourse.julialang.org/u/gdalle)\
**Replies:** 5\
**Last updated:** [February 20, 2025, 2:26pm UTC](https://discourse.julialang.org/t/display-docstring-for-extension-method-in-documentation/99720 "2025-02-20T14:26:49Z")

</div>

What should I do I want to document a method defined in an extension? Of course I wrote a docstring but said docstring isn’t displayed in the Documenter.jl build, even when I load the conditional dependencies before load…

[Next page](https://discourse.julialang.org/tag/documenter/59.md?match_all_tags=true&page=1&tags%5B%5D=documenter)