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

aurelius

v0.1.3

Published

converts javascript code with markdown comments into documentation markdown pages

Downloads

12

Readme

Aurelius

Aurelius is a simple library to convert code with markdown comments to markdown pages.

It's meant to be a helpful tool to convert executable and testable code into documentation pages. One of the hard parts of mantaining an updated documentation is making sure the code examples still work. If you write your documentation pages as code, you can execute them to make sure they are always updated.

Run once

If you want to run aurelius from the command line only once, you can do:

npx aurelius <file paths>

Running from the cli

When you run aurelius from the cli, you have two arguments:

  • --out: path to the folder we will write the markdown files to (if not set, output files will be at the same directory as the input files)
  • every other argument will be treated as input file path globs

Installing

yarn global add aurelius

or

npm install -g aurelius

Running

Then you can run:

aurelius --out <output folder> <file paths>

For example:

aurelius --out docs src/**

As a library

You can also install aurelius as a dependency and use it directly in your code:

In your command line:

yarn add aurelius

In your code:

const aurelius = require('aurelius');

...
const code = await fs.readFile("file.js");
const markdown = aurelius(code, 'javascript');