Skip to content

Commit 7150c2a

Browse files
authored
docs: fix README rendering (#100)
Title levels were incorrect, resulting in unformatted README on GitHub and elsewhere: https://github.com/openedx/frontend-plugin-framework/tree/v1.4.1 FTR this issue was caused by PR #96.
1 parent 11bc86d commit 7150c2a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ file as well to define its plugin slots.
100100
// env.config.js
101101
102102
import { DIRECT_PLUGIN, IFRAME_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';
103-
103+
104104
// import any additional dependencies or functions to be used for each plugin operation
105105
import Sidebar from './widgets/social/Sidebar';
106106
import SocialMediaLink from './widgets/social/SocialMediaLink';
@@ -168,12 +168,12 @@ If you need to use a plugin operation (e.g. Wrap, Hide, Modify) on default conte
168168
Note: The default content will have a priority of 50, allowing for any plugins to appear before or after the default content.
169169

170170
Plugin Operations
171-
=================
171+
`````````````````
172172

173173
There are four plugin operations that each require specific properties.
174174

175175
Insert a Direct Plugin
176-
``````````````````````
176+
''''''''''''''''''''''
177177

178178
The Insert operation will add a widget in the plugin slot. The contents required for a Direct Plugin is the same as
179179
is demonstrated in the Default Contents section above, with the ``content`` key being optional.
@@ -196,7 +196,7 @@ is demonstrated in the Default Contents section above, with the ``content`` key
196196
}
197197
198198
Insert an iFrame Plugin
199-
```````````````````````
199+
'''''''''''''''''''''''
200200

201201
The Insert operation will add a widget in the plugin slot. The contents required for an iFrame Plugin is the same as
202202
is demonstrated in the Default Contents section above.
@@ -220,7 +220,7 @@ is demonstrated in the Default Contents section above.
220220
}
221221
222222
Modify
223-
``````
223+
''''''
224224

225225
The Modify operation allows us to modify the contents of a widget, including its id, type, content, RenderWidget function,
226226
or its priority. The operation requires the id of the widget that will be modified and a function to make those changes.
@@ -248,7 +248,7 @@ or its priority. The operation requires the id of the widget that will be modifi
248248
}
249249
250250
Wrap
251-
````
251+
''''
252252

253253
Unlike Modify, the Wrap operation adds a React component around the widget, and a single widget can receive more than
254254
one wrap operation. Each wrapper function takes in a ``component`` and ``id`` prop.
@@ -276,7 +276,7 @@ one wrap operation. Each wrapper function takes in a ``component`` and ``id`` pr
276276
}
277277
278278
Hide
279-
````
279+
''''
280280

281281
The Hide operation will simply hide whatever content is desired. This is generally used for the default content.
282282

@@ -304,7 +304,7 @@ Fallback Behavior
304304
-----------------
305305

306306
Setting a Fallback component
307-
''''''''''''''''''''''''''''
307+
````````````````````````````
308308
The two main places to configure a fallback component for a given implementation are in the PluginSlot props and in the JS configuration. The JS configuration fallback will be prioritized over the PluginSlot props fallback.
309309

310310
PluginSlot props

0 commit comments

Comments
 (0)