From 18399b348e137eb07d7d3c4ead8e49dbee6de528 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Wed, 3 Feb 2021 23:11:23 +0000 Subject: [PATCH] improve readme --- README.md | 45 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3ed350d..479bd5d 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,43 @@ -# template-docusaurus-plugin +# docusaurus-plugin-remote-content -A Docusaurus plugin template. +A Docusaurus v2 plugin that downloads content from remote sources. -## Alright, how do I use this? +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: + +```bash +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!: -1. Make a new repository using this template. -2. Clone that repository locally using your IDE of choice. -3. Edit `src/index.ts`. -4. Run `yarn build`. -5. Open a second terminal, and make the working directory the `testsite`. -6. Start the test site. -7. You now have the test site running your plugin. +1. Clone a fork of this repository locally using your IDE of choice. +2. Edit the source. +3. Run `yarn build`. +4. Open a second terminal, and make the working directory the `testsite`. +5. Start the test site (`yarn start`). +6. 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: