https://github.com/jasonhughes94/deno-markdown

Generate markdown files with ease 🦕
https://github.com/jasonhughes94/deno-markdown

deno markdown

Last synced: 3 months ago
JSON representation

Generate markdown files with ease 🦕

• Host: GitHub
• URL: https://github.com/jasonhughes94/deno-markdown
• Owner: JasonHughes94
• License: mit
• Created: 2020-06-10T12:25:54.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-07T17:13:49.000Z (over 4 years ago)
• Last Synced: 2024-10-28T12:15:28.256Z (3 months ago)
• Topics: deno, markdown
• Language: TypeScript
• Homepage:
• Size: 60.5 KB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Deno-Markdown

Create markdown files or snippets using deno 🦕

![ci](https://github.com/JasonHughes94/deno-markdown/workflows/ci/badge.svg)

## Usage

### Basic example

```javascript

import { Markdown, ListTypes } from 'https://deno.land/x/deno_markdown/mod.ts';

let markdown = new Markdown();

markdown

  .header('My Header', 1)

  .list(['Item 1', 'Item 2'], ListTypes.Ordered)

  .quote('My Quote');

console.log(markdown.content);

```

### Write out to a markdown file

```javascript

import { Markdown, ListTypes } from 'https://deno.land/x/deno_markdown/mod.ts';

let markdown = new Markdown();

await markdown

  .quote('My Quote')

  .write('./examples/', 'test');

```

### Further examples

Please see the files in [the examples folder](./examples/) or take a look at the [wiki](https://github.com/JasonHughes94/deno-markdown/wiki)

## Running the tests

To run the tests run `deno test -A`

## Contributing

Any help is greatly welcome all you need to do it put in a PR with the changes and ensure that you have added a test(s) for the feature.

## Authors

* **Jason Hughes** - *Initial work* - [Github](https://github.com/JasonHughes94)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgements 

* **Titus Wormer** - [markdown-table](https://github.com/wooorm/markdown-table)