Package Exports

docusaurus-plugin-remote-content

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docusaurus-plugin-remote-content) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

docusaurus-plugin-remote-content

A Docusaurus v2 plugin that downloads content from remote sources.

With this plugin, you can write the Markdown for your docs and blog somewhere else, and use them on your Docusaurus site.

Installing

Run this in a terminal:

yarn add docusaurus-plugin-remote-content

Choosing a Mode

This plugin has 2 modes, and you can choose which to use depending on your needs.

Constant Sync

This is the default mode. You will want to gitignore the docs/blog directory that the plugin downloads content to, as every time you run docusaurus build or docusaurus start, the content is downloaded, (and optionally but enabled by default, when it stops, the local copy of the content is deleted).

CLI Sync

This is the secondary mode. You can use the Docusaurus CLI to update the content when needed. All you need to do is run docusaurus download-remote-X, where X is either blog or docs.

Contributing

It isn't really that hard. Follow these simple steps!:

Clone a fork of this repository locally using your IDE of choice.
Edit the source.
Run yarn build.
Open a second terminal, and make the working directory the testsite.
Start the test site (yarn start).
You now have the test site running the plugin.

When you update the plugin, in order to preview your changes on the test site, you need to:

Use the first shell you opened to re-run yarn build (in the repository's root directory).
In the second shell, Control+C (or Command+C on macOS) the running Docusaurus dev server, and re-run yarn start.