# Swift-DocC sidebar

**URL:** <https://forums.swift.org/t/swift-docc-sidebar/55250>\
**Category:** Swift-DocC\
**Created:** [February 10, 2022, 9:02pm UTC](https://forums.swift.org/t/swift-docc-sidebar/55250 "2022-02-10T21:02:55Z")\
**Posts on this page:** 1\
**Showing post:** 27

<div class="post-metadata">

**Author:** ![ethankusters](https://sea2.discourse-cdn.com/swift/user_avatar/forums.swift.org/ethankusters/32/19078_2.png) [@ethankusters](https://forums.swift.org/u/ethankusters)\
**Post date:** [April 7, 2022, 10:04pm UTC](https://forums.swift.org/t/swift-docc-sidebar/55250/27 "2022-04-07T22:04:29Z")

</div>

I'm excited to announce that the Swift-DocC sidebar has been enabled by default in Swift-DocC-Render with:

> <https://github.com/swiftlang/swift-docc-render/commit/dae1f3e0c24a06c5f0ec49c1dd68457c126aab41>
>
> Fixes: rdar://89089597

The sidebar will only be available for DocC archives produced by the latest version of DocC that includes the necessary [index file](https://forums.swift.org/t/emitting-a-json-representation-of-the-docc-navigator-index/55826).

I've updated the ArgumentParser demo with the latest changes: [https://ethan-kusters.github.io/swift-argument-parser/documentation/argumentparser/](https://ethan-kusters.github.io/swift-argument-parser/documentation/argumentparser/).

If you'd like to try out the sidebar with your own Swift Package, you can do the following:

> **Testing instructions:**
>
> * * *
> 
> Note that I'm going to use the Swift-DocC Plugin to simplify the instructions here but it's not actually required for this functionality. It just makes testing prerelease versions of the `docc` CLI a little more user-friendly.
> 
> 1. Build the latest version of [Swift-DocC](https://github.com/apple/swift-docc):
> 
> ## 
> 
> 1. Set the `DOCC_EXEC` environment variable to your locally built copy of `docc`:
> 
> ```shell
> export DOCC_EXEC=`pwd`/.build/debug/docc
> 
> ```
> 
> ## 
> 
> 1. Clone the latest pre-built version of [Swift-DocC-Render](https://github.com/apple/swift-docc-render):
> 
> ## 
> 
> 1. Set the `DOCC_HTML_DIR` environment variable to your local copy of Swift-DocC-Render:
> 
> ## 
> 
> 1. Adopt the Swift-DocC-Plugin in your package by following the instructions [here](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/).
> 
> ## 
> 
> 1. Change directory to your package and run the [`preview-documentation` command](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/previewing-documentation) for your target:
> 
> ```shell
> cd <path-to-your-package>
> swift package --disable-sandbox preview-documentation --target <name-of-package-target>
> 
> ```
> 
> ## 
> 
> 1. That's it!
> 
> * * *

 ![Screen Shot 2022-04-07 at 3.00.55 PM](https://global.discourse-cdn.com/swift/original/3X/0/a/0aa1769b007764e438202ccea90215a23a29e3c5.jpeg)

If you encounter any issues while trying things out, a bug report on [bugs.swift.org](http://bugs.swift.org) (and soon [GitHub Issues](https://forums.swift.org/t/swift-bugs-are-moving-to-github-issues-and-we-need-your-help/56125)) would be really appreciated.

- Ethan

---

_[View the full topic](https://forums.swift.org/t/swift-docc-sidebar/55250)._