Skip to content

A cli tool to convert plaintext into bionic reading ready markdown

Notifications You must be signed in to change notification settings

rusticmystic/bionicyzer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

bionicyzer

A commandline tool which converts plaintext into bionic reading ready markdown text. The markdown generated by the tool can render bionic reading in vscode preview, github README etc.

It can be used along with gum to do bionic reading on terminal.

Build

Clone the repo: git clone https://github.com/rusticmystic/bionicyzer

Install dependencies: go mod tidy

Build the tool: go build -o bionicyzer

Then copy the bionicyzer tool to ~/.bin and set the path to that folder. export PATH=$PATH:~/.bin/

Usage

The bionicyzer tool reads from stdin and outputs to stdin.

To run the tool, use the command:

echo "This is an example" | bionicyzer > bionic-out.md

We can convert a plain text file into binoinc ready markdown file

cat file.txt | bionicyzer > output.md

License

This tool is licensed under the MIT License - see the LICENSE file for details.

Contributing

To contribute to this tool, please fork this repository and create a pull request with your changes.

About

A cli tool to convert plaintext into bionic reading ready markdown

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages