@shopify/docs-tools v0.0.23

@shopify/docs-tools

Tooling for documenting TypeScript projects at Shopify

Overview

This package provides utilities that will parse the tsdoc comments within a package so that they can be used as output for documentation. This is currently only in use in Checkout for maintaining documentation on Shopify.dev.

API Reference

createDependencyGraph(entry: string)

The createDependencyGraph function produces a Map of strings to Modules for a given entry point.

const graph = await createDependencyGraph(componentIndex);

graph.forEach((value) => {
  console.log(value); // Module object representation of each dependency
});

Resources

• Scripts in Checkout

Publishing this Package

1. Merge your changes into the main branch.
2. Run the yarn prepublish cmd in the repo.
3. Run yarn version --new-version <major|minor|patch> && git push --follow-tags to bump the version.
4. Go to https://shipit.shopify.io/shopify/docs-tools/production to ship the semver commit.