deadsimple literal-ish documentation-generator using awk #tiny #superflexible #markdown

README.md

Foo

bar is printed

The code

//  # Foo
//

function foo(){
  console.log("bar")            //  bar is printed

}

//  # The code
//
//  #code foo.js

//  # My ip
//  
//  #sh curl -s icanhazip.com
//   
//  # My hostname
//  
//  #include /etc/hostname

My ip

80.99.73.15

My hostname

ls540

foo.js

//  # Foo
//

function foo(){
  console.log("bar")            //  bar is printed

}

//  # The code
//
//  #code foo.js

//  # My ip
//  
//  #sh curl -s icanhazip.com
//   
//  # My hostname
//  
//  #include /etc/hostname

generate.sh

 #!/bin/sh
  
  generate(){                  
    cat $1 | awk '/\/\/  / {   
      gsub(".*//  ","",$0);    
      gsub("# ","\n# ",$0);    
      if( match($0,/^#include /) ){ system("cat "$2); next; }
      if( match($0,/^#code /)    ){ print "```\n"; system("cat "$2); print "```\n"; next; }
      if( match($0,/^#sh /)      ){ $1=""; system($0); next; }
      print $0;                
    }'
  }
  
  generate *.js > README.md