Bugfix in LiterateMarkdownGenerator. Documentation moved to doc.jdb-labs.com.
This commit is contained in:
		
							
								
								
									
										21
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										21
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,5 +1,8 @@ | |||||||
| # J Literate Programming | # J Literate Programming | ||||||
|  |  | ||||||
|  | * [Source](https://git.jdb-labs.com/jdb-labs/jlp)   | ||||||
|  | * [Annotated Source and Documentation](https://doc.jdb-labs.com/jlp/current/) | ||||||
|  |  | ||||||
| ## Overview | ## Overview | ||||||
| *Jonathan's Literate Programming* is my take on literate programming. | *Jonathan's Literate Programming* is my take on literate programming. | ||||||
| This project grew out of a desire for a documentation system that: | This project grew out of a desire for a documentation system that: | ||||||
| @@ -57,19 +60,19 @@ This project is in its infancy and some of the larger goals are still unmet: | |||||||
|  |  | ||||||
| ## Project Architecture | ## Project Architecture | ||||||
|  |  | ||||||
| JLP process it's documentation. The latest documentation is available at | JLP processes it's own documentation. The latest documentation is available at | ||||||
| http://jdbernard.github.io/jlp | https://doc.jdb-labs.com/jlp/current/ | ||||||
|  |  | ||||||
| Below are some starting points. | Below are some starting points. | ||||||
|  |  | ||||||
| ### Control and Flow | ### Control and Flow | ||||||
|  |  | ||||||
| * [JLPMain](https://jdbernard.github.io/jlp/doc/src/com/jdblabs/jlp/JLPMain.groovy.html) | * [JLPMain](https://doc.jdb-labs.com/jlp/current/src/main/groovy/com/jdblabs/jlp/JLPMain.groovy.html) | ||||||
|  |  | ||||||
|     The entry point to the JLP executable. Parses the command line input and |     The entry point to the JLP executable. Parses the command line input and | ||||||
|     sets up the processor. |     sets up the processor. | ||||||
|  |  | ||||||
| * [Processor](https://jdbernard.github.io/jlp/doc/src/com/jdblabs/jlp/Processor) | * [Processor](https://doc.jdb-labs.com/jlp/current/src/main/groovy/com/jdblabs/jlp/Processor.groovy.html) | ||||||
|  |  | ||||||
|     The Processor processes one batch of input files to create a set of output files. |     The Processor processes one batch of input files to create a set of output files. | ||||||
|     It holds the intermediate state needed by the generators and coordinates the |     It holds the intermediate state needed by the generators and coordinates the | ||||||
| @@ -77,14 +80,14 @@ Below are some starting points. | |||||||
|     processor only generates HTML documentation and will likely be renamed in |     processor only generates HTML documentation and will likely be renamed in | ||||||
|     the future to reflect this. |     the future to reflect this. | ||||||
|  |  | ||||||
| * [JLPBaseGenerator](https://jdbernard.github.io/jlp/doc/src/com/jdblabs/jlp/JLPBaseGenerator) | * [JLPBaseGenerator](https://doc.jdb-labs.com/jlp/current/src/main/groovy/com/jdblabs/jlp/JLPBaseGenerator.groovy.html) | ||||||
|  |  | ||||||
|     The Generator processes one input file. It parses the AST for the input file |     The Generator processes one input file. It parses the AST for the input file | ||||||
|     and emits the final documentation for the file. JLPBaseGenerator |     and emits the final documentation for the file. JLPBaseGenerator | ||||||
|     implementations are expected to be tightly coupled to Processor |     implementations are expected to be tightly coupled to Processor | ||||||
|     implementations. |     implementations. | ||||||
|  |  | ||||||
| * [LiterateMarkdownGenerator](https://jdbernard.github.io/jlp/doc/src/com/jdblabs/jlp/LiterateMarkdownGenerator) | * [LiterateMarkdownGenerator](https://doc.jdb-labs.com/jlp/current/src/main/groovy/com/jdblabs/jlp/LiterateMarkdownGenerator.groovy.html) | ||||||
|  |  | ||||||
|     This implemetation of JLPBaseGenerator generates literate-style |     This implemetation of JLPBaseGenerator generates literate-style | ||||||
|     documentation (as opposed to API-style), using |     documentation (as opposed to API-style), using | ||||||
| @@ -93,11 +96,11 @@ Below are some starting points. | |||||||
|  |  | ||||||
| ### Parsing | ### Parsing | ||||||
|  |  | ||||||
| * [JLPParser](https://jdbernard.github.io/jlp/doc/src/com/jdblabs/jlp/JLPParser) | * [JLPParser](https://doc.jdb-labs.com/jlp/current/src/main/groovy/com/jdblabs/jlp/JLPParser.groovy.html) | ||||||
|  |  | ||||||
|     A very simple interface for parsing JLP input. |     A very simple interface for parsing JLP input. | ||||||
|  |  | ||||||
| * [JLPPegParser](https://jdbernard.github.io/jlp/doc/src/com/jdblabs/jlp/JLPPegParser) | * [JLPPegParser](https://doc.jdb-labs.com/jlp/current/src/main/groovy/com/jdblabs/jlp/JLPPegParser.groovy.html) | ||||||
|  |  | ||||||
|     A [PEG parser](http://en.wikipedia.org/wiki/Parsing_expression_grammar) |     A [PEG parser](http://en.wikipedia.org/wiki/Parsing_expression_grammar) | ||||||
|     implemented using the [parboiled](http://www.parboiled.org) library. This |     implemented using the [parboiled](http://www.parboiled.org) library. This | ||||||
| @@ -107,6 +110,6 @@ Below are some starting points. | |||||||
|  |  | ||||||
| ### Abstract Syntax Tree | ### Abstract Syntax Tree | ||||||
|  |  | ||||||
| * [SourceFile](https://jdbernard.github.io/jlp/doc/src/com/jdblabs/jlp/JLPPegParserSourceFile) | * [SourceFile](https://doc.jdb-labs.com/jlp/current/src/main/groovy/com/jdblabs/jlp/JLPPegParserSourceFile.groovy.html) | ||||||
|  |  | ||||||
|     The top-level AST element. This represents a source file. |     The top-level AST element. This represents a source file. | ||||||
|   | |||||||
| @@ -2,7 +2,7 @@ apply plugin: "groovy" | |||||||
| apply plugin: "maven" | apply plugin: "maven" | ||||||
|  |  | ||||||
| group = "com.jdblabs" | group = "com.jdblabs" | ||||||
| version = "1.8" | version = "1.9" | ||||||
|  |  | ||||||
| repositories { | repositories { | ||||||
|     mavenLocal() |     mavenLocal() | ||||||
|   | |||||||
| @@ -19,7 +19,7 @@ import org.slf4j.LoggerFactory | |||||||
|  */ |  */ | ||||||
| public class JLPMain { | public class JLPMain { | ||||||
|  |  | ||||||
|     public static final String VERSION = "1.8" |     public static final String VERSION = "1.9" | ||||||
|  |  | ||||||
|     private static Logger log = LoggerFactory.getLogger(JLPMain.class) |     private static Logger log = LoggerFactory.getLogger(JLPMain.class) | ||||||
|  |  | ||||||
|   | |||||||
| @@ -248,7 +248,7 @@ public class LiterateMarkdownGenerator extends JLPBaseGenerator { | |||||||
|             [lineNumber, line] } |             [lineNumber, line] } | ||||||
|  |  | ||||||
|         /// Sort by line number. |         /// Sort by line number. | ||||||
|         codeLines.sort({ i1, i2 -> i1[0] - i2[0] } as Comparator) |         codeLines.sort { i1, i2 -> i1[0] <=> i2[0] } | ||||||
|  |  | ||||||
|         codeLines = codeLines.collect { arr -> arr[1] } |         codeLines = codeLines.collect { arr -> arr[1] } | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user