/docusaurus-plugin-snipsync

Snipsync plugin for docusaurus - insert snippets into markdown files

Primary LanguageTypeScriptMIT LicenseMIT

docusaurus-plugin-snipsync

Integrates snipsync into the docusaurus build process.

Installation

In the same directory as your docusaurus installation run:

npm install docusaurus-plugin-snipsync

-- Or --

yarn add docusaurus-plugin-snipsync

Usage

Add the plugin to the list of plugins in your docusaurus.config.js

module.exports = {
  // ...
  plugins: [
    [
      'docusaurus-plugin-snipsync',
      {
        origins: [
          {
            files: ['../*/src/*.ts', '../create-project/samples/*.ts'],
          },
        ],
        target: 'docs',
        features: {
          enable_source_link: false,
        },
      },
    ],
  ],
};