Skip to content

gbluma/literate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

An incredibly simple tool for handling literate programming.

Usage

literate -s example.lc > example.c
=> outputs the source code from example.lc

literate -d example.lc > example.md
=> outputs the documentation from example.lc

Formatting

There are only two rules. First, normal text is considered a comment. Second, lines that start with ">" are considered code. But it works on any language.

This is a top level comment.

This is also a comment.

> /* this is a comment that will show up in code */
>
> int main(int argc, char** argv) {
>     printf("Hello world\n");
>     return 0;
> }

Closing comments.

About

A bare-bones literate programming tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages