Add README to ext-latex module
This commit is contained in:
		
							parent
							
								
									582b9209d9
								
							
						
					
					
						commit
						078d4dfc38
					
				
							
								
								
									
										46
									
								
								markwon-ext-latex/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										46
									
								
								markwon-ext-latex/README.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,46 @@ | ||||
| # LaTeX | ||||
| 
 | ||||
| This is a small extension that will help you display LaTeX formulas in your markdown. | ||||
| Syntax is pretty simple: pre-fix and post-fix your latex with `$$` (double dollar sign). | ||||
| `$$` should be the first characters in a line. | ||||
| 
 | ||||
| ```markdown | ||||
| $$ | ||||
| \\text{A long division \\longdiv{12345}{13} | ||||
| $$ | ||||
| ``` | ||||
| 
 | ||||
| ```markdown | ||||
| $$\\text{A long division \\longdiv{12345}{13}$$ | ||||
| ``` | ||||
| 
 | ||||
| ```java | ||||
| Markwon.builder(context) | ||||
|     .use(CorePlugin.create()) | ||||
|     .use(ImagesPlugin.create(context)) | ||||
|     .use(JLatexMathPlugin.create(new Config(textSize)) | ||||
|     .build(); | ||||
| ``` | ||||
| 
 | ||||
| This extension uses [jlatexmath-android](https://github.com/noties/jlatexmath-android) artifact to create LaTeX drawable. Then it | ||||
| registers special `latex` image scheme handler and uses `AsyncDrawableLoader` to display | ||||
| final result | ||||
| 
 | ||||
| ## Config | ||||
| 
 | ||||
| ```java | ||||
| public static class Config { | ||||
| 
 | ||||
|     protected final float textSize; | ||||
| 
 | ||||
|     protected Drawable background; | ||||
| 
 | ||||
|     @JLatexMathDrawable.Align | ||||
|     protected int align = JLatexMathDrawable.ALIGN_CENTER; | ||||
| 
 | ||||
|     protected boolean fitCanvas = true; | ||||
| 
 | ||||
|     protected int padding; | ||||
| } | ||||
| ``` | ||||
| 
 | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Dimitry Ivanov
						Dimitry Ivanov