https://github.com/osama-mhmd/marking-down

Now you can customize
https://github.com/osama-mhmd/marking-down

markdown md typescript

Last synced: 3 days ago
JSON representation

Now you can customize

• Host: GitHub
• URL: https://github.com/osama-mhmd/marking-down
• Owner: osama-mhmd
• License: mit
• Created: 2024-02-08T20:19:54.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-02-10T15:31:22.000Z (8 months ago)
• Last Synced: 2024-09-14T03:12:41.445Z (14 days ago)
• Topics: markdown, md, typescript
• Language: TypeScript
• Homepage: https://osama-mhmd.github.io/marking-down/
• Size: 72.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        


  marking-down





  
Now you can customize


`marking-down` is a library that enables you to customize and use components inside of your .md file. See this example:

```md

Hi! Here are my latest blogs :)

{

  ### How to succeed in life

  @@Some tips to succeed in life by Osama Mohammed...@@

}

{

  ### How to succeed in programming

  @@Some tips to succeed in programming by Osama Mohammed...@@

}

```

See the output live: https://osama-mhmd.github.io/marking-down#example-1

- [Installation](#installation)

- [Quick Start](#quick-start)

- [Features](#features)

## Installation

```bash

# using npm

npm install marking-down

# using yarn

yarn add marking-down

# using pnpm

pnpm add marking-down

```

## Quick Start

### React

In your react app, add these lines

```jsx

// page.tsx

import { mdFile } from "marking-down";

import * as path from "path";

export function Blog() {

  return (

    


  );

}

```


```md

--> blog.md

# Installation

- with [react](#react)

- with next.js

```