Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to Docs #48

Merged
merged 1 commit into from
Nov 10, 2022
+36 −0
Merged

Updates to Docs #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ This is the secondary mode. You can use the Docusaurus CLI to update the content
All you need to do is run `docusaurus download-remote-X`, where X is the `name` option given to the plugin.
You can also use `docusaurus clear-remote-X` to remove the downloaded files.

To enable CLI Sync set `noRuntimeDownloads: true` in the options.

## Alright, so how do I use this??

Okay. Assuming you want to use constant sync, follow these steps:
Expand Down Expand Up @@ -133,6 +135,40 @@ ${content}`, // <-- this last part adds in the rest of the content, which would
},
```

## Fetching Images
To fetch images you need to have 2 instances of the plugin - 1 for markdown, and the other for images. With the images one, you would add `requestConfig: { responseType: "arraybuffer" }`

### Example
```javascript
module.exports = {
// ...
plugins: [
[
"docusaurus-plugin-remote-content",
{
// options here
name: "markdown-content", // used by CLI, must be path safe
sourceBaseUrl: "https://my-site.com/content/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs", // the base directory to output to.
documents: ["my-file.md", "README.md"], // the file names to download
},
],
[
"docusaurus-plugin-remote-content",
{
// options here
name: "images-content", // used by CLI, must be path safe
sourceBaseUrl: "https://my-site.com/content/", // the base url for the markdown (gets prepended to all of the documents when fetching)
outDir: "docs", // the base directory to output to.
documents: ["my-image.png", "cool.gif"], // the file names to download
requestConfig: { responseType: "arraybuffer" }
},
],
],
}
```


## Contributing

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