enable website build

Author: elong0527

_pkgdown.yml

@@ -88,7 +88,13 @@ reference:
   - "rtf_footnote"
   - "rtf_source"
   - "rtf_encode"
+- title: Write to File
+  contents:
   - "write_rtf"
+  - "write_docx"
+  - "write_html"
+- title: Assemble Documents
+  contents:
   - "assemble_rtf"
   - "assemble_docx"
 - title: RTF Figure

vignettes/rtf-convert-format.Rmd

@@ -22,15 +22,48 @@ r2rtf:::rtf_convert_format(
 
 ## Overview
 
-`r2rtf` had an experimental internal function `r2rtf:::rtf_convert_format` to 
-convert RTF format to PDF, DOCX, or HTML. 
-This feature requires LibreOffice >= 7.1 and was only 
-tested in a Linux environment. 
+`r2rtf` provides multiple ways to convert RTF format to other formats including PDF, DOCX, and HTML:
 
-By default, `r2rtf:::rtf_convert_format` convert RTF file to PDF format.
+1. **User-facing functions**: `write_docx()` and `write_html()` - Exported functions for converting RTF encoding to DOCX or HTML
+2. **Internal function**: `r2rtf:::rtf_convert_format()` - Lower-level function for batch conversion of RTF files
+
+All conversion features require LibreOffice >= 7.1 and currently support Unix/Linux/macOS systems only.
+
+## Using write_docx() and write_html()
+
+The `write_docx()` and `write_html()` functions provide a simple interface to convert RTF encoding directly to DOCX or HTML formats.
+
+### Write DOCX
+
+```{r, eval = FALSE}
+# Create RTF encoding
+rtf <- head(iris) |>
+  rtf_body() |>
+  rtf_encode()
+
+# Convert to DOCX
+write_docx(rtf, "output/table.docx")
+```
+
+### Write HTML
+
+```{r, eval = FALSE}
+# Create RTF encoding
+rtf <- head(cars) |>
+  rtf_body() |>
+  rtf_encode()
+
+# Convert to HTML
+write_html(rtf, "output/table.html")
+```
+## Using rtf_convert_format() (Advanced)
+
+The internal `r2rtf:::rtf_convert_format()` function provides more control for batch processing of existing RTF files.
+
+By default, `r2rtf:::rtf_convert_format` converts RTF files to PDF format.
 The PDF file will be saved in the same folder with same file name by default.
 
-In example below, `ae_example.pdf` will be created in the same folder. 
+In the example below, `ae_example.pdf` will be created in the same folder. 
 
 ```{r, eval = FALSE}
 r2rtf:::rtf_convert_format(input = "rtf/ae_example.rtf")
@@ -42,7 +75,7 @@ r2rtf:::rtf_convert_format(input = "rtf/ae_example.rtf")
 r2rtf:::rtf_convert_format(input = list.files("rtf", pattern = "*.rtf"))
 ```
 
-- The `format` argument allow use to specify output format as `pdf`, `docx`, or `html`. 
+- The `format` argument allows you to specify output format as `pdf`, `docx`, or `html`. 
 
 ```{r, eval = FALSE}
 r2rtf:::rtf_convert_format(input = "rtf/ae_example.rtf", format = "html")