You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Clone the project repository to the root of `plone/documentation`.
33
+
1. Delete any non-documentation files from the clone.
34
+
1. Move the documentation files and subfolders to the root of the clone, retaining the documentation structure.
35
+
1. Convert the reStructuredText documentation files to MyST.
36
+
The example commands below assume that there are files at the root of the clone and in one sub-level of nested directories. For deeper nesting, insert globbing syntax for each sub-level as `**/`
37
+
38
+
```shell
39
+
bin/rst2myst convert -R project/*.rst
40
+
bin/rst2myst convert -R project/**/*.rst
41
+
```
42
+
43
+
1. Add HTML meta data to the converted files.
44
+
45
+
```shell
46
+
cd project
47
+
../bin/python ../docs/addMetaData.py
48
+
```
49
+
50
+
1. Optionally clean up any MyST syntax.
51
+
1. Commit and push your branch to GitHub and create a pull request.
0 commit comments