From 897d9e6e6403319328bd914a0023cccf0e880f07 Mon Sep 17 00:00:00 2001 From: Stavros Ntentos <133706+stdedos@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:46:36 +0300 Subject: [PATCH] `README.md` cleanup Continue and improve the cf23010748cae13a0a0c65b95a08b5f818602198 work Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com> --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 18750cf..fea91c4 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ You can also supply the hostname, username, password, token, and space as **envi If you are using self-signed certificates or want to **ignore SSL errors**, use the `--insecure` option. -You can **upload multiple files** or entire folders. If you specify a folder, `md2cf` will traverse it recursively and upload all files that end in `.md`. For more information, see [Uploading Folders](#uploading-folders). +You can **upload multiple files** or entire folders. If you specify a folder, `md2cf` will traverse it recursively and upload all files that end in `.md`. For more information, see [Uploading Folders Recursively](#uploading-folders-recursively). If you would like to preview `md2cf`'s actions without modifying Confluence, use the `--dry-run` option. This will print a list of page data without making any changes. @@ -182,7 +182,7 @@ By default, relative links that point to non-existent files (or files that are n ### Uploading Folders Recursively -To help you mirror large documentation to Confluence, `md2cf` allows you to upload entire folders. When using this feature, `md2cf` will recursively traverse all subdirectories and upload any `.md` files it encounters. +To help you mirror a large documentation to Confluence, `md2cf` allows you to upload entire folders. When using this feature, `md2cf` will recursively traverse all subdirectories and upload any `.md` files it encounters. By default, `md2cf` will respect your `.gitignore` file and skip any files or folders it defines. If you prefer to upload everything in the folder, use the `--no-gitignore` option. @@ -190,11 +190,6 @@ Please note that Confluence can only nest pages under other pages. As a result, #### Customizing folder names -Folder names like `interesting-subsection` or `dir1` are not particularly nice. If you pass the `--beautify-folders` option, all spaces and hyphens in folder names will be replaced with spaces and the first letter will be capitalized, producing `Interesting subsection` and `Dir1`. - -Alternatively, you can create a YAML file called `.pages` with the following format in every folder you wish to rename. -If you pass the `--use-pages-file`, the folder will be given that title. - Folder names like `interesting-subsection` or `dir1` may not be aesthetically pleasing. If you use the `--beautify-folders` option, spaces and hyphens in folder names will be replaced with spaces, and the first letter of each word will be capitalized, resulting in `Interesting Subsection` and `Dir1`. Alternatively, you can create a YAML file called `.pages` in every folder you want to rename, using the following format, and if you use the `--use-pages-file` option, the folder will be renamed using the title specified in the `.pages` file.