Skip to content

Commit

Permalink
chore(build): fix newline in inline docs causing website build failur…
Browse files Browse the repository at this point in the history
…es (#1050)
  • Loading branch information
mirceanis authored Nov 1, 2022
1 parent 55cd3e6 commit fe10c70
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
15 changes: 8 additions & 7 deletions packages/core/src/types/IDIDManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,8 @@ export interface IDIDManager extends IPluginMethodMap {
* Creates and returns a new identifier
*
* @param args - Required. Arguments to create the identifier
* @param context - *RESERVED* This is filled by the framework when the method is called. This method's <a
* href="/docs/agent/plugins#executing-plugin-methods">Execution context</a> requires an `agent` that has
* @param context - *RESERVED* This is filled by the framework when the method is called. This method's
* <a href="/docs/agent/plugins#executing-plugin-methods">execution context</a> requires an `agent` that has
* {@link @veramo/core#IKeyManager} methods.
*
* @example
Expand Down Expand Up @@ -324,9 +324,10 @@ export interface IDIDManager extends IPluginMethodMap {

/**
* Returns an existing identifier or creates a new one for a specific alias
* @param args - The alias used for the search and the provider/kms/options used to create the DID when none is found.
* @param context - *RESERVED* This is filled by the framework when the method is called. This method's <a
* href="/docs/agent/plugins#executing-plugin-methods">execution context</a> requires an `agent` that has
* @param args - The alias used for the search and the provider/kms/options used to create the DID when none is
* found.
* @param context - *RESERVED* This is filled by the framework when the method is called. This method's
* <a href="/docs/agent/plugins#executing-plugin-methods">execution context</a> requires an `agent` that has
* {@link @veramo/core#IKeyManager} methods.
*/
didManagerGetOrCreate(
Expand All @@ -337,8 +338,8 @@ export interface IDIDManager extends IPluginMethodMap {
/**
* Updates the DID document of a managed {@link @veramo/core#IIdentifier | DID}.
* @param args - the arguments necessary for the update. The options are specific for each DID provider.
* @param context - *RESERVED* This is filled by the framework when the method is called. This method's <a
* href="/docs/agent/plugins#executing-plugin-methods">execution context</a> requires an `agent` that has
* @param context - *RESERVED* This is filled by the framework when the method is called. This method's
* <a href="/docs/agent/plugins#executing-plugin-methods">execution context</a> requires an `agent` that has
* {@link @veramo/core#IKeyManager} methods.
*/
didManagerUpdate(args: IDIDManagerUpdateArgs, context: IAgentContext<IKeyManager>): Promise<IIdentifier>
Expand Down
5 changes: 4 additions & 1 deletion scripts/docs-build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,11 @@ async function main() {
input.close()

const header = ['---', `id: ${id}`, `title: ${title}`, `hide_title: true`, '---']
let outputString = header.concat(output).join('\n')

await writeFile(docPath, header.concat(output).join('\n'))
outputString = outputString.replace(/<a\nhref=/g, '<a href=')

await writeFile(docPath, outputString)
} catch (err) {
console.error(`Could not process ${docFile}: ${err}`)
}
Expand Down

0 comments on commit fe10c70

Please sign in to comment.