Skip to content

JasonHughes94/deno-markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Deno-Markdown

Create markdown files or snippets using deno 🦕

ci

Usage

Basic example

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

const 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

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

const markdown = new Markdown()

await markdown
  .quote("My Quote")
  .write("./examples/", "test")

Further examples

Please see the files in the examples folder or take a look at the 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

License

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

Acknowledgements