markdown_segment {ragnar} | R Documentation |
Segment markdown text
Description
Segment markdown text
Usage
markdown_segment(
text,
tags = c("h1", "h2", "h3", "h4"),
trim = FALSE,
omit_empty = FALSE
)
markdown_frame(text, frame_by = c("h1", "h2", "h3"), segment_by = NULL)
Arguments
text |
Markdown string |
tags , segment_by |
A character vector of html tag names, e.g.,
|
trim |
logical, trim whitespace on segments |
omit_empty |
logical, whether to remove empty segments |
frame_by |
Character vector of tags that will become columns in the returned dataframe. |
Value
A named character vector. Names will correspond to tags
, or ""
for content in between tags.
Examples
md <- r"---(
# Sample Markdown File
## Introduction
This is a sample **Markdown** file for testing.
### Features
- Simple **bold** text
- _Italicized_ text
- `Inline code`
- A [link](https://example.com)
- ‘Curly quotes are 3 bytes chars.’ Non-ascii text is fine.
This is a paragraph with <p> tag.
This next segment with code has a <pre> tag
```r
hello_world <- function() {
cat("Hello, World!\n")
}
```
A table <table>:
| Name | Age | City |
|-------|----:|-----------|
| Alice | 25 | New York |
| Bob | 30 | London |
## Conclusion
Common tags:
- h1, h2, h3, h4, h5, h6: section headings
- p: paragraph (prose)
- pre: pre-formatted text, meant to be displayed with monospace font.
Typically code or code output
- blockquote: A blockquote
- table: A table
- ul: Unordered list
- ol: Ordered list
- li: Individual list item in a <ul> or <ol>
)---"
markdown_segment(md) |> tibble::enframe()
markdown_segment(md |> trimws()) |> tibble::enframe()
markdown_segment(md, c("li"), trim = TRUE, omit_empty = TRUE) |> tibble::enframe()
markdown_segment(md, c("table"), trim = TRUE, omit_empty = TRUE) |> tibble::enframe()
markdown_segment(md, c("ul"), trim = TRUE, omit_empty = TRUE) |> tibble::enframe()
[Package ragnar version 0.2.0 Index]