Package 'aeolus'

Title: Unleash Useful Linebreaks in Markdown Documents
Description: Add linebreaks at the end of sentences and remove other linebreaks.
Authors: Maëlle Salmon [cre, aut]
Maintainer: Maëlle Salmon <[email protected]>
License: MIT + file LICENSE
Version: 0.0.0.9000
Built: 2024-12-19 13:30:15 UTC
Source: https://github.com/ropenscilabs/aeolus

Help Index


Create better line breaks

Description

Currently unleash() only adds line breaks after sentences. For better results, you should also add line breaks after long sentence parts, manually.

Usage

unleash(path, new_path = path)

Arguments

path

Path to the Markdown file

new_path

Path where to save the new file

Value

Path to the new file (invisibly)

Examples

markdown_file <- system.file("example.md", package = "aeolus")
readLines(markdown_file)
unleash(markdown_file)
readLines(markdown_file)

Set Visual editor's Markdown wrapping option to "Sentence" (RStudio IDE).

Description

Set Visual editor's Markdown wrapping option to "Sentence" (RStudio IDE).

Usage

use_sentence_linebreaks(scope = c("user", "project"))

Arguments

scope

Edit globally for the current user, or locally for the current project.

Value

Nothing, used for its side-effects.