瀏覽代碼

Some docs polish

@arturi
AJvanLoon 6 年之前
父節點
當前提交
cff26a8876
共有 1 個文件被更改,包括 5 次插入1 次删除
  1. 5 1
      website/src/docs/progressbar.md

+ 5 - 1
website/src/docs/progressbar.md

@@ -22,12 +22,16 @@ uppy.use(ProgressBar, {
 
 
 This plugin is published as the `@uppy/progress-bar` package.
 This plugin is published as the `@uppy/progress-bar` package.
 
 
+Install from NPM:
+
 ```shell
 ```shell
 npm install @uppy/progress-bar
 npm install @uppy/progress-bar
 ```
 ```
 
 
 ## Options
 ## Options
 
 
+The Progressbar plugin has the following configurable options:
+
 ```js
 ```js
 uppy.use(ProgressBar, {
 uppy.use(ProgressBar, {
   target: '.UploadForm',
   target: '.UploadForm',
@@ -61,4 +65,4 @@ When true, hides the progress bar after the upload has finished. If false, it re
 
 
 ### `replaceTargetContent: false`
 ### `replaceTargetContent: false`
 
 
-Remove all children of the `target` element before mounting the ProgressBar. By default, Uppy will append any UI to the `target` DOM element. This is the least dangerous option. However, you may have some fallback HTML inside the `target` element in case JavaScript or Uppy is not available. In that case you can set `replaceTargetContent: true` to clear the `target` before appending.
+Remove all children of the `target` element before mounting the ProgressBar. By default, Uppy will append any UI to the `target` DOM element. This is the least dangerous option. However, you may have some fallback HTML inside the `target` element in case JavaScript or Uppy is not available. In that case, you can set `replaceTargetContent: true` to clear the `target` before appending.