From 9a1d65568191acb82ae5c4997b06f85883bc2c9c Mon Sep 17 00:00:00 2001 From: Matti Pastell Date: Thu, 29 Dec 2016 16:34:39 +0200 Subject: [PATCH] Added docs for inline syntax --- doc/src/usage.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/src/usage.md b/doc/src/usage.md index adbb313..917a55d 100644 --- a/doc/src/usage.md +++ b/doc/src/usage.md @@ -120,3 +120,20 @@ Weave will remove the first empty space from each line of documentation. [See sample document:](https://github.com/mpastell/Weave.jl/blob/master/examples/FIR_design.jl) + +## Inline code + +You can also add inline code to your documents using + +``` +`j juliacode` +``` + +syntax. The code will be replaced with the output of running the code. +If the code produces figures the filename or base64 encoded string will be +added to output e.g. to include a Plots figure in markdown you can use: + +``` +![A plot](`j plot(1:10)`) +``` +