# \#documentation

**URL:** https://discourse.julialang.org/tag/documentation/7.md

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

---

## [Documentation for suffixes of string macros?](https://discourse.julialang.org/t/documentation-for-suffixes-of-string-macros/139658)

<div class="topic-metadata">

**Author:** [@matthias314](https://discourse.julialang.org/u/matthias314)\
**Replies:** 4\
**Last updated:** [September 25, 2026, 3:09am UTC](https://discourse.julialang.org/t/documentation-for-suffixes-of-string-macros/139658 "2026-09-25T03:09:38Z")

</div>

The README file on GitHub mentions that StaticStrings.jl uses string macros of the form static"Hello world!"12 which take more than one parameter. I didn’t know that this is possible. Is this described anywhere in the Ju…

---

## [\[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(...) …

---

## [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…

---

## [Document Expr(:symbolicgoto, ...) and :symboliclabel](https://discourse.julialang.org/t/document-expr-symbolicgoto-and-symboliclabel/137267)

<div class="topic-metadata">

**Author:** [@Tamas\_Papp](https://discourse.julialang.org/u/Tamas_Papp)\
**Replies:** 10\
**Last updated:** [May 24, 2026, 1:26pm UTC](https://discourse.julialang.org/t/document-expr-symbolicgoto-and-symboliclabel/137267 "2026-05-24T13:26:13Z")

</div>

To get something equivalent to @goto foo and @label foo in a macro, one has to use Expr(:symbolicgoto, :foo) or Expr(:symbolicgoto, :foo) (see eg this and similar topics). Would it make sense to document this in the doc…

---

## [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…

---

## [\[ANN\] DocumenterTypst.jl - Fast PDF Generation for Documenter.jl via Typst](https://discourse.julialang.org/t/ann-documentertypst-jl-fast-pdf-generation-for-documenter-jl-via-typst/134772)

<div class="topic-metadata">

**Author:** [@lucifer1004](https://discourse.julialang.org/u/lucifer1004)\
**Replies:** 14\
**Last updated:** [April 3, 2026, 9:51am UTC](https://discourse.julialang.org/t/ann-documentertypst-jl-fast-pdf-generation-for-documenter-jl-via-typst/134772 "2026-04-03T09:51:45Z")

</div>

TL;DR: A new Documenter.jl backend that generates professional PDFs 10x faster than LaTeX, with zero setup required. Two years ago, I shared an early experiment with using Typst as a backend for Documenter.jl. Today, …

---

## [\[Documentation Incomplete Explanation?\] Methods Chapter - Redefining Methods](https://discourse.julialang.org/t/documentation-incomplete-explanation-methods-chapter-redefining-methods/135695)

<div class="topic-metadata">

**Author:** [@fincleah](https://discourse.julialang.org/u/fincleah)\
**Replies:** 4\
**Last updated:** [February 20, 2026, 11:04am UTC](https://discourse.julialang.org/t/documentation-incomplete-explanation-methods-chapter-redefining-methods/135695 "2026-02-20T11:04:06Z")

</div>

Hi - I’m currently reading the manual to learn Julia. I’ve spotted maybe an incomplete example in the Methods chapter on redefining methods. It seems to say that there are two definitions of the newfun() function, but …

---

## [Documented \`const\` fields of a \`mutable struct\` does not show up in documentation](https://discourse.julialang.org/t/documented-const-fields-of-a-mutable-struct-does-not-show-up-in-documentation/135723)

<div class="topic-metadata">

**Author:** [@pmc4](https://discourse.julialang.org/u/pmc4)\
**Replies:** 2\
**Last updated:** [February 19, 2026, 12:19pm UTC](https://discourse.julialang.org/t/documented-const-fields-of-a-mutable-struct-does-not-show-up-in-documentation/135723 "2026-02-19T12:19:38Z")

</div>

Hello, everyone. While I was adding some docstrings to a mutable struct, I’ve realized that when the field is set as constant, the documentation doesn’t work. Take, for example, the following mutable struct: "Some rando…

---

## [\[Documentation Minor Typo?\] Parametric Methods - Statement Regarding Return Type Declarations](https://discourse.julialang.org/t/documentation-minor-typo-parametric-methods-statement-regarding-return-type-declarations/135694)

<div class="topic-metadata">

**Author:** [@fincleah](https://discourse.julialang.org/u/fincleah)\
**Replies:** 0\
**Last updated:** [February 16, 2026, 10:28pm UTC](https://discourse.julialang.org/t/documentation-minor-typo-parametric-methods-statement-regarding-return-type-declarations/135694 "2026-02-16T22:28:53Z")

</div>

Hi All, I’ve been reading through the manual in order to learn Julia, and I’m on the Methods chapter. However, I think I’ve spotted a typo? It’s a very minor thing - but I think the sentence is saying that the where st…

---

## [Multichar variables names in docstring LaTeX](https://discourse.julialang.org/t/multichar-variables-names-in-docstring-latex/135555)

<div class="topic-metadata">

**Author:** [@Tamas\_Papp](https://discourse.julialang.org/u/Tamas_Papp)\
**Replies:** 4\
**Last updated:** [February 11, 2026, 8:09am UTC](https://discourse.julialang.org/t/multichar-variables-names-in-docstring-latex/135555 "2026-02-11T08:09:34Z")

</div>

What’s the recommended way to include a multi-character function or argument name in the LaTeX/math part of a docstring? \\text, \\mathrm, or something else? MWE: @doc """ Test if \`\`x \\\\le \\\\text{abstol}\`\`. """ is\_done(x…

---

## [Create Julia manual offline](https://discourse.julialang.org/t/create-julia-manual-offline/98412)

<div class="topic-metadata">

**Author:** [@David\_Sagan](https://discourse.julialang.org/u/David_Sagan)\
**Replies:** 8\
**Last updated:** [February 3, 2026, 4:26pm UTC](https://discourse.julialang.org/t/create-julia-manual-offline/98412 "2026-02-03T16:26:47Z")

</div>

I will have a long flight where I will be offline. I would like to setup on my computer (a mac) an image of the Julia manual to look at during the flight. How can I do this? Thanks for any info.

---

## [Adopt the SciML Style Guide for Julia Base and Standard Library?](https://discourse.julialang.org/t/adopt-the-sciml-style-guide-for-julia-base-and-standard-library/134845)

<div class="topic-metadata">

**Author:** [@mkitti](https://discourse.julialang.org/u/mkitti)\
**Replies:** 10\
**Last updated:** [January 3, 2026, 11:51pm UTC](https://discourse.julialang.org/t/adopt-the-sciml-style-guide-for-julia-base-and-standard-library/134845 "2026-01-03T23:51:09Z")

</div>

After thinking about docstrings from another post, I was wondering if the Julia Style Guide, particularly for Core, Base, and the standard libraries should be further specified, particularly for docstrings. Perhaps a …

---

## [Understanding iterate() documentation is tough](https://discourse.julialang.org/t/understanding-iterate-documentation-is-tough/134715)

<div class="topic-metadata">

**Author:** [@raman\_kumar](https://discourse.julialang.org/u/raman_kumar)\
**Replies:** 3\
**Last updated:** [December 24, 2025, 12:32am UTC](https://discourse.julialang.org/t/understanding-iterate-documentation-is-tough/134715 "2025-12-24T00:32:35Z")

</div>

Understanding iterate() documentation is made tough although everyone use it easily. Is Julia for loop behind the scene a while loop? julia\> for i in 1:5 println(i) end is equivalent to :down\_arrow: …

---

## [\[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…

---

## [RFC: TypstDocs.jl (Julia package documentation in typst)](https://discourse.julialang.org/t/rfc-typstdocs-jl-julia-package-documentation-in-typst/134422)

<div class="topic-metadata">

**Author:** [@ExpandingMan](https://discourse.julialang.org/u/ExpandingMan)\
**Replies:** 4\
**Last updated:** [December 8, 2025, 2:14am UTC](https://discourse.julialang.org/t/rfc-typstdocs-jl-julia-package-documentation-in-typst/134422 "2025-12-08T02:14:04Z")

</div>

Many of us in the Julia community are enthusiastic about the typst typesetting language, which shares similar goals with latex but with a radically different design philosophy. Currently typst is mostly used to output P…

---

## [\`Threads.atomic\_cas!\`, \`Threads.SpinLock\`, and \`@atomic\` documentation](https://discourse.julialang.org/t/threads-atomic-cas-threads-spinlock-and-atomic-documentation/134369)

<div class="topic-metadata">

**Author:** [@Marco\_Lombardi](https://discourse.julialang.org/u/Marco_Lombardi)\
**Replies:** 2\
**Last updated:** [December 5, 2025, 2:16pm UTC](https://discourse.julialang.org/t/threads-atomic-cas-threads-spinlock-and-atomic-documentation/134369 "2025-12-05T14:16:55Z")

</div>

Reading the Julia manual, I see that there is a “mild” deprecation for a series of atomic-related functions, including Threads.atomic\_cas!. I understand this is in favor of the @atomic macro, which is apparently more gra…

---

## [Autocomplete and Documentation issues in the Julia plugin for VSCode](https://discourse.julialang.org/t/autocomplete-and-documentation-issues-in-the-julia-plugin-for-vscode/133367)

<div class="topic-metadata">

**Author:** [@joemaik](https://discourse.julialang.org/u/joemaik)\
**Replies:** 0\
**Last updated:** [October 22, 2025, 6:47pm UTC](https://discourse.julialang.org/t/autocomplete-and-documentation-issues-in-the-julia-plugin-for-vscode/133367 "2025-10-22T18:47:31Z")

</div>

I am running VSCode 1.105.1 with the julialang.language-julia plugin version 1.149.2. TL-DR: I am having issues getting Autocomplete and the Documentation running for basic Julia packages such as LinearAlgebra, inside V…

---

## [Documentation understanding feedbacks](https://discourse.julialang.org/t/documentation-understanding-feedbacks/132899)

<div class="topic-metadata">

**Author:** [@raman\_kumar](https://discourse.julialang.org/u/raman_kumar)\
**Replies:** 9\
**Last updated:** [October 22, 2025, 5:59am UTC](https://discourse.julialang.org/t/documentation-understanding-feedbacks/132899 "2025-10-22T05:59:09Z")

</div>

I thing it would be better to have a system where reader can give feedback of how much they understood a section in documentation chapter. This will help us create better documentation system. They can give star ratti…

---

## [What new() in inner costructor do?](https://discourse.julialang.org/t/what-new-in-inner-costructor-do/133251)

<div class="topic-metadata">

**Author:** [@raman\_kumar](https://discourse.julialang.org/u/raman_kumar)\
**Replies:** 5\
**Last updated:** [October 18, 2025, 9:38pm UTC](https://discourse.julialang.org/t/what-new-in-inner-costructor-do/133251 "2025-10-18T21:38:14Z")

</div>

What does new in general do in inner constructor? For example in this code in documentation how new know the work( here create instance if x\>y) it should do? Constructors · The Julia Language julia\> struct OrderedPair…

---

## [Julia Type system manual confusions](https://discourse.julialang.org/t/julia-type-system-manual-confusions/132583)

<div class="topic-metadata">

**Author:** [@raman\_kumar](https://discourse.julialang.org/u/raman_kumar)\
**Replies:** 38\
**Last updated:** [October 6, 2025, 6:51am UTC](https://discourse.julialang.org/t/julia-type-system-manual-confusions/132583 "2025-10-06T06:51:31Z")

</div>

What are now latest best learning resources of Julia type system? I am Physics student. I have been using Julia since last 2 years. I have read this Types introduction section many times but still i don’t grasp it compl…

---

## [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…

---

## [Suggestion: updating the dispatch vs. dict/switch benchmark link in the manual](https://discourse.julialang.org/t/suggestion-updating-the-dispatch-vs-dict-switch-benchmark-link-in-the-manual/132159)

<div class="topic-metadata">

**Author:** [@DanielSussman](https://discourse.julialang.org/u/DanielSussman)\
**Replies:** 1\
**Last updated:** [September 9, 2025, 6:32pm UTC](https://discourse.julialang.org/t/suggestion-updating-the-dispatch-vs-dict-switch-benchmark-link-in-the-manual/132159 "2025-09-09T18:32:24Z")

</div>

I was reading through the (extremely helpful!) “performance tips” part of of the manual. In the “dangers of absuing multiple dispatch…” section there is a link to “run-time benchmarks comparing (1) type dispatch, (2) dic…

---

## [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…

---

## [False positives when searching documentations](https://discourse.julialang.org/t/false-positives-when-searching-documentations/124793)

<div class="topic-metadata">

**Author:** [@fgerick](https://discourse.julialang.org/u/fgerick)\
**Replies:** 4\
**Last updated:** [July 18, 2025, 12:35am UTC](https://discourse.julialang.org/t/false-positives-when-searching-documentations/124793 "2025-07-18T00:35:43Z")

</div>

Hi, I have encountered this a few times already (without remembering other references): I just searched for “thread” in the Optimizations.jl documentation, giving two results: However, after clicking on the first pa…

---

## [Looking for more detailed documentation of \`PlotlyLight.jl\`](https://discourse.julialang.org/t/looking-for-more-detailed-documentation-of-plotlylight-jl/111009)

<div class="topic-metadata">

**Author:** [@WuSiren](https://discourse.julialang.org/u/WuSiren)\
**Replies:** 4\
**Last updated:** [July 14, 2025, 10:07am UTC](https://discourse.julialang.org/t/looking-for-more-detailed-documentation-of-plotlylight-jl/111009 "2025-07-14T10:07:31Z")

</div>

I found that the PlotlyLight package is very good and very useful to me, but its documentation is currently a bit brief (or I didn’t find it in the right place). Is there any more detailed instructions on its use? Thanks…

---

## [Confusion in The return Keyword](https://discourse.julialang.org/t/confusion-in-the-return-keyword/130525)

<div class="topic-metadata">

**Author:** [@raman\_kumar](https://discourse.julialang.org/u/raman_kumar)\
**Replies:** 4\
**Last updated:** [July 6, 2025, 7:32pm UTC](https://discourse.julialang.org/t/confusion-in-the-return-keyword/130525 "2025-07-06T19:32:59Z")

</div>

In this code given in Julia documentation i got following results. Is there some discrepancy? julia\> function hypot(x, y) x = abs(x) y = abs(y) if x \> y r = y/x …

---

## [DocumenterVitepress light and dark mode images/figures](https://discourse.julialang.org/t/documentervitepress-light-and-dark-mode-images-figures/130477)

<div class="topic-metadata">

**Author:** [@cneverett](https://discourse.julialang.org/u/cneverett)\
**Replies:** 0\
**Last updated:** [July 4, 2025, 7:03pm UTC](https://discourse.julialang.org/t/documentervitepress-light-and-dark-mode-images-figures/130477 "2025-07-04T19:03:16Z")

</div>

Hello, I am using DocumenterVitepress.jl to generate some documentation for a package I am developing. I have generated both light and dark mode versions of figures (saved as png) that I would like to include in the doc…

---

## [Documentation Formats - epub mobi pdf](https://discourse.julialang.org/t/documentation-formats-epub-mobi-pdf/7700)

<div class="topic-metadata">

**Author:** [@guslen](https://discourse.julialang.org/u/guslen)\
**Replies:** 11\
**Last updated:** [June 13, 2025, 1:51pm UTC](https://discourse.julialang.org/t/documentation-formats-epub-mobi-pdf/7700 "2025-06-13T13:51:12Z")

</div>

Hi, I was wondering, if there is any chance that you could publish an ebook-version for the documentation (docs.julialang.org) which is automatically generated? possible formats like: epub, pdf or mobi This would be u…

---

## [Documenting nested functions](https://discourse.julialang.org/t/documenting-nested-functions/129708)

<div class="topic-metadata">

**Author:** [@maxwell3025](https://discourse.julialang.org/u/maxwell3025)\
**Replies:** 2\
**Last updated:** [June 9, 2025, 6:15am UTC](https://discourse.julialang.org/t/documenting-nested-functions/129708 "2025-06-09T06:15:53Z")

</div>

I’m currently working on a project and I came across an issue with using nested functions. In particular, I have a nested function that I want to document, and I am getting a warning about “replacing docs”. This seems …

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