https://github.com/willuhmjs/smileydown

A compiled markdown language that uses emoticons.
https://github.com/willuhmjs/smileydown

markdown

Last synced: 3 days ago
JSON representation

A compiled markdown language that uses emoticons.

• Host: GitHub
• URL: https://github.com/willuhmjs/smileydown
• Owner: willuhmjs
• Created: 2022-04-29T20:30:31.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-04T22:30:45.000Z (almost 3 years ago)
• Last Synced: 2024-04-28T05:42:39.040Z (9 months ago)
• Topics: markdown
• Language: TypeScript
• Homepage: https://willuhmjs.github.io/SmileyDown/
• Size: 185 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SmileyDown

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

[https://willuhm-js.github.io/SmileyDown](https://willuhm-js.github.io/SmileyDown)

A compiled markdown language that uses emoticons. 

## Installation & Usage

Download the [latest image](https://github.com/willuhm-js/SmileyDown/releases/tag/latest) for your machine from the Releases section.

### From Source

```

git clone https://www.github.com/willuhm-js/SmileyDown/

deno run --allow-read --allow-write SmileyDown/src/index.ts [-i input]

```

## Example File

```

📣Never gonna give you up!

🔊Artist

🦍Never Gonna Give You Up🦍 is ⛔not⛔ sung by Rick Astley.

🔊YouTube Video

🔗https://www.youtube.com/watch?v=dQw4w9WgXcQ🔗

```

## Formatting Table

  

    

      Emoji

      Description

      Input

      Output

    

  

  

    

      📣

      Heading 1

      📣Heading 1

      # Heading 1

    

    

      🔊

      Heading 2

      🔊Heading 2

      ## Heading 2

    

    

      🔉

      Heading 3

      🔉Heading 3

      ### Heading 3

    

    

      🔈

      Heading 4

      🔈Heading 4

      #### Heading 4

    

    

      🔗

      Link

      🔗https://www.example.com🔗

      [https://www.example.com](https://www.example.com)

    

    

      🖼

      Image

      🖼./example.jpg🖼

      ![./example.jpg](./example.jpg)

    

    

      💻

      Code

      💻Hello, world!💻

      `Hello, world!`

    

    

      🖥

      Code Block

      🖥Hello, world!🖥

      ```Hello, world!```

    

    

      ⛔

      Strikethrough

      ⛔Lorem ispum⛔

      ~~Lorem ispum~~

    

    

      🦍

      Bold

      🦍Lorem ispum🦍

      **Lorem ispum**

    

    

      🎩

      Italics

      🎩Lorem ispum🎩

      *Lorem ispum*

    

    

      📜

      Block Quote

      📜There once was a man from Nantucket...

      > There once was a man from Nantucket...

    

    

      📋

      Unordered List

      

        📋Item 1


        📋Item 2


        📋Item 3

      

      

        - Item 1


        - Item 2


        - Item 3

      

    

  

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Tristan
💻 ⚠️

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!