Giter Club home page Giter Club logo

swampnutz's Introduction

Swampnutz

Generate and deploy a single static page from a markdown file. Partially inspired by this tweet.

Why is it named Swampnutz? Great question!

Prerequisites

  • Node 10+
  • npm version 5.2.0 or higher (npx support required!)

Running

Method 1 - use npx

Run npx swampnutz my_markdown_file.md

Method 2 - Install globally

Install globally with npm install -g swampnutz.

Now you can use swampnutz markdown_file.md. Follow the prompts to make a surge.sh account and have fun!

Optionally, you may pass in a title with --title

npx swampnutz my_markdown_file.md --title "Look at me"

Purpose

To quickly publish a markdown page on the live internet with as little to no friction as possible.

Why is this called Swampnutz?

swampnutz's People

Contributors

mrbenj avatar lewislin3 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.