@sfdocs-internal/remark-include-resolver v0.1.3

Remark Include Resolver

Why

We encountered failures in the linters because of inlcude plugin in doc framework.

What

This package is a unified (remark) plugin, specifically a include directive resolver . It resolves the shared file content included with the inline include.

For e.g

# Managed Runtime Overview

This guide covers the main parts of Managed Runtime and how to access it.

::include{src="../../shared/managed-runtime-access.md"}

To illustrate, In the snippet mentioned above include directive i.e ::include{src="../../shared/managed-runtime-access.md"} is trying to include the managed-runtime-access.md in this md file from the given path. It resolves the content dynamically.

Install & build

yarn install && yarn build

Pubilsh

yarn publish

Please make sure to push your changes (version number & other changes) to git once publishing is complete.