-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
63 lines (37 loc) · 3.24 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
<!-- badges: start -->
[](https://mayankagrawalbond.shinyapps.io/live-knit-rmd/)
[](https://shiny.rstudio.com/)
[](http://commonmark.org)
[](https://www.latex-project.org/)
[](https://opensource.org/licenses/MIT)
[]()
<!-- badges: end -->
# Introduction
This R Shiny application provides an intitutive user experenice to write markdown documents and see the live rendering on the fly.
Since the output of markdown is native HTML, it paves way for multiple use cases of this application, few of which are listed below -
- Write blog posts directly in markdown, which can be then integrated with any web development tech stack, such as Wordpress, MERN, React, Native HTML/CSS/JS etc.
- Write custom e-mailers in markdown, which can be then automatetd to send to 100s of recipents through Robotic Process automation using R, Python, Java.
- Write project reports in markdown and style with css, so that all your reports have consitent styling and you are focused more on content creation.
- Users new to markdown format can play with this app to get a hang of its capability.
Additional fun features of this application are -
- View all available `BootStrap` themes via the Theme Selection widget.
- Fully Customize the look and feel of your R Shiny Web application or any bootstrap powered web application by defining/changing color varaibales powered by **SASS**.
## Website
The Markdown application is deployed and live at [shinyapps.io](https://mayankagrawalbond.shinyapps.io/live-knit-rmd/)
## [Dashboard Screenshots](https://mayankagrawalbond.shinyapps.io/live-knit-rmd/)
#### Home Page - View Tab
[](https://mayankagrawalbond.shinyapps.io/live-knit-rmd/)
#### Create Tab
[](https://mayankagrawalbond.shinyapps.io/live-knit-rmd/)
#### Editor Themes
[](https://mayankagrawalbond.shinyapps.io/live-knit-rmd/)
#### App Themes
[](https://mayankagrawalbond.shinyapps.io/live-knit-rmd/)
##### Application References
This application uses two major chunks in its implementation, as follows.
1. **Ace Editor** - [shinyAce](https://github.com/trestletech/shinyAce) is a R package wrapper to implement the live text editor input section.
2. [**knitr**](https://github.com/yihui/knitr) - R package to convert markdown documents to various formats such as - .docx, .ppt, HTML, ioslides among a few other. Here, we specifically knit it to HTML for live preview update. [Here](https://github.com/yihui/knitr/tree/master/inst/shiny) is the repo for the simple implementation of it via more web dev route, from 8 years ago.