# Generate rich navigable HTML docs using Nunavut

**URL:** <https://forum.opencyphal.org/t/generate-rich-navigable-html-docs-using-nunavut/1163>\
**Category:** Nunavut\
**Created:** [March 25, 2021, 6:01am UTC](https://forum.opencyphal.org/t/generate-rich-navigable-html-docs-using-nunavut/1163 "2021-03-25T06:01:03Z")\
**Posts on this page:** 4\
**Page:** 2

<div class="post-metadata">

**Author:** ![bbworld1](https://forum.opencyphal.org/user_avatar/forum.opencyphal.org/bbworld1/32/786_2.png) [@bbworld1](https://forum.opencyphal.org/u/bbworld1)\
**Post date:** [May 4, 2021, 7:26pm UTC](https://forum.opencyphal.org/t/generate-rich-navigable-html-docs-using-nunavut/1163/21 "2021-05-04T19:26:44Z")

</div>

There’s quite a bit of code cleanup still needed, and a couple of features and fixes still need to be implemented, so I would wait a bit to actually review the code - at least until the weekend. I’ll update the preview today to include the new syntax highlighting and text formatting. If you’d like to take a glance at the code @scottdixon I’d definitely appreciate it, but just be warned that it’s all WIP, so it’s not very clean.

I’ll continue to post updates on progress as we get closer to merging this feature.

---

<div class="post-metadata">

**Author:** ![bbworld1](https://forum.opencyphal.org/user_avatar/forum.opencyphal.org/bbworld1/32/786_2.png) [@bbworld1](https://forum.opencyphal.org/u/bbworld1)\
**Post date:** [June 16, 2021, 5:19pm UTC](https://forum.opencyphal.org/t/generate-rich-navigable-html-docs-using-nunavut/1163/22 "2021-06-16T17:19:25Z")

</div>

Update:

 ![image](https://forum.opencyphal.org/uploads/default/original/1X/47eb5e05623a4e81a3ea5f3f6c8ac1a6a4d347bf.png)  
 ![image](https://forum.opencyphal.org/uploads/default/original/1X/7911d9b7d1ec1d3323f60168e422db08e8984b92.png)

Search and sidebar work!

I think this should mostly do it for features. We should be ready to merge after a little bug-cleaning and code cleanup.

---

<div class="post-metadata">

**Author:** ![bbworld1](https://forum.opencyphal.org/user_avatar/forum.opencyphal.org/bbworld1/32/786_2.png) [@bbworld1](https://forum.opencyphal.org/u/bbworld1)\
**Post date:** [July 23, 2021, 7:35pm UTC](https://forum.opencyphal.org/t/generate-rich-navigable-html-docs-using-nunavut/1163/23 "2021-07-23T19:35:26Z")

</div>

In case people have not been following, the HTML documentation has been merged into Nunavut.

HTML documentation can be generated and hosted on [Nunaweb](https://nunaweb.uavcan.org). For instance, here is the HTML documentation for the uavcan public regulated data types:  
[https://nunaweb.uavcan.org/api/storage/docs/uavcan/uavcan/index.html](https://nunaweb.uavcan.org/api/storage/docs/uavcan/uavcan/index.html)

To generate HTML documentation locally via Nunavut, use the `--experimental-languages` and `--target-language html` flags.

---

<div class="post-metadata">

**Author:** ![pavel.kirienko](https://forum.opencyphal.org/user_avatar/forum.opencyphal.org/pavel.kirienko/32/9_2.png) [@pavel.kirienko](https://forum.opencyphal.org/u/pavel.kirienko)\
**Post date:** [July 23, 2021, 8:15pm UTC](https://forum.opencyphal.org/t/generate-rich-navigable-html-docs-using-nunavut/1163/24 "2021-07-23T20:15:24Z")

</div>

Fantastic work, by the way. Thank you, Vincent.

[Previous page](https://forum.opencyphal.org/t/generate-rich-navigable-html-docs-using-nunavut/1163.md?page=1)