mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-10-30 18:17:55 +00:00
e61bd967e3
* move script to scripts folder * add docfy to router and scripts * add docfy to router and scripts * fix jsdoc syntax * add component markdown files to gitignore * improve error handling for scripts * tidy up remaining jsdoc syntax * add sample jsdoc components * add known issue info * make not using multi-line components clearer * make generating docs clearer * update copy * final how to docfy cleanup * fix ts file @module syntax * fix read more syntax * make docfy typescript compatible
29 lines
874 B
JavaScript
29 lines
874 B
JavaScript
/**
|
|
* Copyright (c) HashiCorp, Inc.
|
|
* SPDX-License-Identifier: BUSL-1.1
|
|
*/
|
|
|
|
import ExternalLink from './external-link';
|
|
|
|
/**
|
|
* @deprecated
|
|
* @module DocLink
|
|
* DocLink components are used to render anchor links to relevant Vault documentation at developer.hashicorp.com.
|
|
*
|
|
* @example
|
|
* <DocLink @path="/vault/docs/secrets/kv/kv-v2.html">Learn about KV v2</DocLink>
|
|
*
|
|
* * Use HDS link components instead with "doc-link" helper for path prefix
|
|
* <Hds::Link::Standalone @text="Docs" @href={{doc-link "/vault/tutorials"}} @icon="learn-link" @iconPosition="trailing" />
|
|
*
|
|
* @param {string} path=/ - The path to documentation on developer.hashicorp.com that the component should link to.
|
|
*
|
|
*/
|
|
export default class DocLinkComponent extends ExternalLink {
|
|
host = 'https://developer.hashicorp.com';
|
|
|
|
get href() {
|
|
return `${this.host}${this.args.path}`;
|
|
}
|
|
}
|