Giter Club home page Giter Club logo

showdowncss's Introduction

ShowdownCSS ๐ŸŽจ

License GitHub stars GitHub issues Visitors

Hey there! Welcome to ShowdownCSS, the CSS library made for styling Markdown content parsed by Showdown! ๐Ÿš€

Spice up your Markdown content! ๐Ÿ”ฅ

Features

  • Styling for Markdown elements like headers, paragraphs, lists, code blocks, blockquotes, tables, links, and horizontal rules.
  • Different themes available, with the default one provided.

Installation

You can include ShowdownCSS in your project using a CDN:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/SH20RAJ/ShowdownCSS@main/showdown.css">

Usage ๐Ÿค“

  1. First, make sure you have a Markdown file ready to go! ๐Ÿ“„

  2. Include ShowdownCSS in your HTML file:

    <head>
      <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/SH20RAJ/ShowdownCSS@main/showdown.css">
    </head>
  3. Wrap your Markdown content in a div with the class .showdowncontainer:

    <div class="showdowncontainer">
      <!-- Your Markdown content goes here! -->
    </div>
  4. That's it! ๐ŸŽ‰ Your Markdown content inside .showdowncontainer will now be styled beautifully by ShowdownCSS!

Example ๐ŸŒˆ

Here's a quick example of how to use ShowdownCSS:

You can also use version specific cdn like https://cdn.jsdelivr.net/gh/SH20RAJ/ShowdownCSS@d13e0cf619eaf668450c40fcf71afb9691f7e051/showdown.css -> Create it from jsDelivr.

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>ShowdownCSS Example</title>
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/SH20RAJ/ShowdownCSS@main/showdown.css">
</head>
<body>

<div class="showdowncontainer">
  <h1>Hello, Markdown! ๐Ÿ‘‹</h1>
  
  <p>This is **bold** and this is *italic*.</p>
  
  <ul>
    <li>Item 1</li>
    <li>Item 2</li>
    <li>Item 3</li>
  </ul>
  
  <blockquote>This is a blockquote. ๐Ÿ—ฃ๏ธ</blockquote>
  
  <pre><code class="language-javascript">function hello() {
    console.log("Hello, World!");
  }</code></pre>
  
  <p>That's it! Your Markdown is now styled! ๐ŸŽ‰</p>
</div>

</body>
</html>

Themes ๐ŸŽจ

ShowdownCSS comes with different themes for your Markdown content. You can easily switch themes by including the theme CSS file:

Default Theme

The default theme is applied automatically when you include showdown.css.

Dark Theme

To use the Dark Theme, include the following CSS file:

See Demo on Codepen

<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/SH20RAJ/ShowdownCSS@main/themes/dark-theme.css">

Custom Themes

ShowdownCSS welcomes contributions! If you're eager to add your own theme, feel free to contribute to the project by adding your theme file to the themes directory.

Live Demo:

Check out the live demo on CodePen or visit our GitHub repository or Dev.to post to learn more, explore the themes, and contribute your own ideas. ๐ŸŒˆ

Demo ๐ŸŒ

Check out the demo to see ShowdownCSS in action! - (https://sh20raj.github.io/ShowdownCSS/)_

About the Author ๐Ÿ’ก

ShowdownCSS is created with โค๏ธ by Sh Raj.

If you have any feedback, suggestions, or questions, feel free to reach out on Twitter @sh20raj!

Enjoy your beautifully styled Markdown with ShowdownCSS! ๐ŸŒŸ

showdowncss's People

Contributors

sh20raj avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.