From 43e0785a811fda462d7924ed850b80235f6d4d9e Mon Sep 17 00:00:00 2001 From: mysticmind Date: Fri, 12 Feb 2021 20:45:56 +0530 Subject: [PATCH] Fix paths for import code snippets docs --- docs/guide/markdown.md | 16 ++++++++-------- .../snippets}/snippet-with-region.js | 0 .../fragments => docs/snippets}/snippet.js | 0 3 files changed, 8 insertions(+), 8 deletions(-) rename {__tests__/node/markdown/fragments => docs/snippets}/snippet-with-region.js (100%) rename {__tests__/node/markdown/fragments => docs/snippets}/snippet.js (100%) diff --git a/docs/guide/markdown.md b/docs/guide/markdown.md index 0fc3728c..57c7fc23 100644 --- a/docs/guide/markdown.md +++ b/docs/guide/markdown.md @@ -329,31 +329,31 @@ module.exports = { You can import code snippets from existing files via following syntax: ``` md -<<< ./filepath +<<< @/filepath ``` It also supports [line highlighting](#line-highlighting-in-code-blocks): ``` md -<<< ./filepath{highlightLines} +<<< @/filepath{highlightLines} ``` **Input** ``` md -<<< ./../__tests__/node/markdown/fragments/snippet.js{2} +<<< @/snippets/snippet.js{2} ``` **Output** -<<< ./../__tests__/node/markdown/fragments/snippet.js{2} +<<< @/snippets/snippet.js{2} ::: tip -The value of `.` corresponds to `process.cwd()`. +The value of `@` corresponds to `process.cwd()`. ::: You can also use a [VS Code region](https://code.visualstudio.com/docs/editor/codebasics#_folding) to only include the corresponding part of the code file. You can provide a custom region name after a `#` following the filepath (`snippet` by default): @@ -361,14 +361,14 @@ You can also use a [VS Code region](https://code.visualstudio.com/docs/editor/co **Input** ``` md -<<< ./../__tests__/node/markdown/fragments/snippet-with-region.js{1} +<<< @/snippets/snippet-with-region.js{1} ``` **Code file** -<<< ./../__tests__/node/markdown/fragments/snippet-with-region.js +<<< @/snippets/snippet-with-region.js @@ -376,7 +376,7 @@ You can also use a [VS Code region](https://code.visualstudio.com/docs/editor/co -<<< ./../__tests__/node/markdown/fragments/snippet-with-region.js#snippet{1} +<<< @/snippets/snippet-with-region.js#snippet{1} diff --git a/__tests__/node/markdown/fragments/snippet-with-region.js b/docs/snippets/snippet-with-region.js similarity index 100% rename from __tests__/node/markdown/fragments/snippet-with-region.js rename to docs/snippets/snippet-with-region.js diff --git a/__tests__/node/markdown/fragments/snippet.js b/docs/snippets/snippet.js similarity index 100% rename from __tests__/node/markdown/fragments/snippet.js rename to docs/snippets/snippet.js