npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

purs-to-md

v0.3.0

Published

Small CLI tool that I use to generate Markdown README files from PureScript files. Multiline comments become plain markdown, and normal code become markdown code blocks, very simple.

Downloads

2

Readme

purs-to-md

Small CLI tool that I use to generate Markdown README files from PureScript files. Multiline comments become plain markdown, and normal code become markdown code blocks, very simple.

Installation

npm install purs-to-md

CLI Options

purs-to-md --help
purs-to-md - Convert PureScript files with comments to Markdown

Usage: purs-to-md.js --input-purs ARG [--output-md ARG] [--debug]
  Convert PureScript files with comments to Markdown

Available options:
  -h,--help                Show this help text
  --input-purs ARG         PureScript file to read from
  --output-md ARG          Markdown file to write to
                           (File path or '-' for stdout, defaults to '-')
  --debug                  Print debug information

Example

Define a PureScript file like this:

Sample.purs

module Sample where

import Prelude

{-
Let's define some variables:
-}

a :: Int
a = 3

b :: Int
b = 3

{-
And do some calculation:
-}

c :: Int
c = a + b

Then run the CLI like so:

purs-to-md --input-purs Sample.purs --output-md sample.md

This will generate the following Markdown file:

sample.md

```hs
module Sample where

import Prelude
```

Let's define some variables:


```hs
a :: Int
a = 3

b :: Int
b = 3
```

And do some calculation:


```hs
c :: Int
c = a + b
```

Limitations

Note that the {- and -} must be written in dedicated lines. This won't work : {- Some Text .. -}. Also don't expect edge cases to be handled, like e.g. PureScript strings that contain {- will break the generator.