https://github.com/maelle/aeolus

Help you use the only worthy line breaks in Markdown
https://github.com/maelle/aeolus

Last synced: 18 days ago
JSON representation

Help you use the only worthy line breaks in Markdown

• Host: GitHub
• URL: https://github.com/maelle/aeolus
• Owner: maelle
• License: other
• Created: 2024-12-02T13:52:55.000Z (21 days ago)
• Default Branch: main
• Last Pushed: 2024-12-02T14:46:47.000Z (21 days ago)
• Last Synced: 2024-12-02T14:48:21.523Z (21 days ago)
• Language: R
• Homepage:
• Size: 0 Bytes
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# aeolus

[![R-CMD-check](https://github.com/maelle/aeolus/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/maelle/aeolus/actions/workflows/R-CMD-check.yaml)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

The goal of aeolus is to create better, more semantic linebreaks in your Markdown file.

aEOLus, get it? :wink:

## Installation

You can install the development version of aeolus like so:

``` r

pak::pak("maelle/aeolus")

```

## Why have semantic linebreaks?

For any Markdown parser the two following code chunks are the same:

```md

This is a sentence. This is another

sentence.

```

```md

This is a sentence. 

This is another sentence.

```

However, the second one will make your work easier when you use version control.

Git treats code by **line** so if lines are logical units as opposed to random units

or units of a certain length, 

the Git diff is better. 

If you change one sentence in a paragraph, and that paragraph is a single line, 

the Git diff is less readable.

With semantic linebreaks, code suggestions in GitHub Pull Requests are easier to make and use.

More information: .

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}

library(aeolus)

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

readLines(markdown_file)

unleash(markdown_file)

readLines(markdown_file)

```