docs

docs is a private package for the Fuel documentation site.

Table of contents

• docs
• Table of contents
  • Building
  • Testing
  • Referencing snippets

Building

The build process will build out our snippets and the documentation.

pnpm build

The build process generates testable scripts from the snippets and outputs them alongside the snippets. The corresponding typegen types are also generated and outputted in the src/snippets/typegend folder. All test scripts end with a .test.ts suffix.

Testing

This will build the snippets and run the generated tests. To test a specific environment (node or browser), the snippet should contain one of the following tags:

/**
 * @group browser
 */

or

/**
 * @group node
 */

If no environment is specified, it will run in the browser and node environments by default.

pnpm test

Referencing snippets

To reference a snippet outside of the current directory, you need to use the following syntax (<<< @/):

`<<< @/../../path/to/snippet.ts#snippet-name{language:line-numbers}

To reference a snippet in the current directory, you can use the following syntax (<<< @./):

`<<< @./snippets/transaction-request/fetch-resources.ts#transaction-request-5{ts:line-numbers}