# Any "bridge" between Documenter.jl and YAML.jl in order to document a YAML file?

**URL:** <https://discourse.julialang.org/t/any-bridge-between-documenter-jl-and-yaml-jl-in-order-to-document-a-yaml-file/114909>\
**Category:** General Usage\
**Tags:** documentation, documenter, yaml\
**Created:** [May 29, 2024, 11:54am UTC](https://discourse.julialang.org/t/any-bridge-between-documenter-jl-and-yaml-jl-in-order-to-document-a-yaml-file/114909 "2024-05-29T11:54:57Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![sylvaticus](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/sylvaticus/32/203883_2.png) [@sylvaticus](https://discourse.julialang.org/u/sylvaticus)\
**Post date:** [May 29, 2024, 11:54am UTC](https://discourse.julialang.org/t/any-bridge-between-documenter-jl-and-yaml-jl-in-order-to-document-a-yaml-file/114909/1 "2024-05-29T11:54:57Z")

</div>

Ok, I have chosen YAML for the settings of my model.

Is there a way I can format the comments in YAML in a certain way in order to document the settings, parse these special comments and let them end up in a make\_doc Documenter workflow together with the rest of the documentation of my package ?

Or alternatively embed the yaml file as a separate page on my package documentation ?

---

<div class="post-metadata">

**Author:** ![mortenpi](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/mortenpi/32/158_2.png) [@mortenpi](https://discourse.julialang.org/u/mortenpi)\
**Post date:** [May 30, 2024, 12:30am UTC](https://discourse.julialang.org/t/any-bridge-between-documenter-jl-and-yaml-jl-in-order-to-document-a-yaml-file/114909/2 "2024-05-30T00:30:37Z")

</div>

Seems like maybe a job for Literate.jl? It’s mainly meant for Julia files, but if you don’t actually try to execute it, then it might be possible to also make it work for other languages.