23 lines
839 B
Markdown
23 lines
839 B
Markdown
|
<!--THIS FILE IS AUTO GENERATED. This file is generated from JSDoc comments in lib/core/addon/components/doc-link.js. To make changes, first edit that file and run "yarn gen-story-md doc-link" to re-generate the content.-->
|
||
|
|
|
||
|
|
## DocLink
|
||
|
|
`DocLink` components are used to render anchor links to relevant Vault documentation.
|
||
|
|
|
||
|
|
|
||
|
|
| Param | Type | Default | Description |
|
||
|
|
| --- | --- | --- | --- |
|
||
|
|
| path | <code>String</code> | <code>"/"</code> | The path to documentation on vaultproject.io that the component should link to. |
|
||
|
|
|
||
|
|
**Example**
|
||
|
|
|
||
|
|
```js
|
||
|
|
<DocLink @path="/docs/secrets/kv/kv-v2.html">Learn about KV v2</DocLink>
|
||
|
|
```
|
||
|
|
|
||
|
|
**See**
|
||
|
|
|
||
|
|
- [Uses of DocLink](https://github.com/hashicorp/vault/search?l=Handlebars&q=DocLink)
|
||
|
|
- [DocLink Source Code](https://github.com/hashicorp/vault/blob/master/ui/app/components/doc-link.js)
|
||
|
|
|
||
|
|
---
|