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
Copy file name to clipboardExpand all lines: docs/updating-legacy-docs/converting-rst-to-md.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -61,17 +61,17 @@ Once the work is done, submit a PR to merge it into the main branch.
61
61
```
62
62
- This will generate .md files within `./build/markdown`
63
63
2. We want to replace all of the .rst files with the .md files, *however*if we simply delete the .rst and add the .md we will lose all of the git history!
64
-
- To get around this, we're going to first *rename* all of the .rst files to .md, and *then* overwrite the "fake" renamed .md files with the converted .md files
64
+
- To get around this, we're going to first *rename* all of the .rst files to .md, and *then* overwrite the "fake" renamed .md files with the converted .md files
65
65
3. Using your renamer tool of choice, rename all .rst files in docs/ to the .md extension
66
66
4. **Commit this rename change!**
67
-
- Be careful not to commit anything in `./build/`, as we don't want these in the repo (yet)
67
+
- Be careful not to commit anything in `./build/`, as we don't want these in the repo (yet)
68
68
5. Now, overwrite all `./docs/` .md files with those from `./build/markdown/`
69
69
6. Delete the `./build/` folder, as it won't be needed
70
70
7. Rename `./docs/index.md` to `./docs/_nav.md`
71
-
- This is a temporary process that we'll resolve later
72
-
- It needs to be rewritten in a different format, and moved into `./mkdocs.yml`, with this file deleted
71
+
- This is a temporary process that we'll resolve later
72
+
- It needs to be rewritten in a different format, and moved into `./mkdocs.yml`, with this file deleted
73
73
8. **Commit this overwrite change!**
74
-
- This solidifies the history, at which point we can start cleanup
74
+
- This solidifies the history, at which point we can start cleanup
75
75
76
76
---
77
77
@@ -147,13 +147,13 @@ When finished, delete `./docs/_nav.md`.
147
147
- `[CharacterRange.pasteFrom()](../text/characterrange.md#characterrange-pastefrom)` to
0 commit comments