roam {litedown} | R Documentation |
Preview Markdown and R Markdown files
Description
Launch a web page to list and preview files under a directory.
Usage
roam(dir = ".", live = TRUE, ...)
Arguments
dir |
A directory path. |
live |
Whether to enable live preview. If enabled, the browser page will be automatically updated upon modification of local files used by the page (e.g., the Markdown file or external CSS/JS/image files). If disabled, you can manually refresh the page to fully re-render it. |
... |
Other arguments to be passed to |
Details
Markdown files will be converted to HTML and returned to the web browser directly without writing to HTML files, to keep the directory clean during the preview. Clicking on a filename will bring up an HTML preview. To see its raw content, click on the link on its file size instead.
Value
A URL (invisibly) for the preview.
[Package litedown version 0.7 Index]