package mdx
Executable code blocks inside markdown files
Install
Dune Dependency
Authors
Maintainers
Sources
mdx-1.5.0.tbz
sha256=b68fea7235aa95a407bccea76352a8a32dee0441a72f701f3aa19d4f1cbd853c
sha512=2853e68f2e91ea36f3f22459ff1cd512237e6380163434e2bd59eee1946d166119663aaafb5acd672cbf285d9f191aee2e39fa5f587cbd41020eeae8815887cf
doc/CHANGES.html
1.5.0 (2019-11-29)
Added
- Add a
--output
/-o
option to thetest
subcommand to allow specifying a different output file to write the corrected to, or to write it to the standard output (#194, @NathanReb) - Migrate to OCaml 4.08 AST to add support for
let*
bindings (#190, @gpetiot) - Add
--syntax
option torule
subcommand to allow generating rules for cram tests (#177, @craigfe) - Add a
require-package
label to explicitly declare dunepackage
dependencies of a code block (#149, @Julow) - Add an
unset-
label to unset env variables in shell blocks (#132, @clecat)
Changed
- Format rules generated by
ocaml-mdx rule
usingdune format-dune-file
(#184, @NathanReb) - Run promotion of markdown files before
.ml
files in generated dune rules (#140, @clecat)
Fixed
- Use module_presence information on Env.summary to prevent fetching absent modules from the toplevel env (#186, @clecat)
- Remove trailing whitespaces at the end of toplevel or bash evaluation lines (#166, @clecat)
- Improve error reporting of ocaml-mdx test (#172, @Julow)
- Rule: Pass the --section option to
test
(#176, @Julow) - Remove trailing whitespaces from shell outputs and toplevel evals (#166, @clecat)
- Remove inappropriate empty lines in generated dune rules (#163, @Julow)
- Fix ignored
skip
label inocaml-mdx pp
(#1561, @CraigFe) - Fix synchronization of new parts from markdown to
.ml
(#156, @Julow) - Fix ignored
[@@@parts ...]
markers within module definitions (#155, @Julow) - Fix a bug in internal OCaml version comparison that lead to crashes in some cases (#145, @gpetiot)
- Promote to empty
.ml
file when usingto-ml
direction (#139, @clecat) - Apply
--force-output
to.ml
file as well (#137, @clecat) - Fix a bug preventing
.corrected
files to be written in some cases (#136, @clecat) - Add compatibility with
4.09.0
(#133, @xclerc)
Removed
- Remove the
output
subcommand as it was very specific to RealWorldOCaml needs (#195, @NathanReb) - Remove the
infer-timestamp
direction (#171 @Julow)
1.4.0 (2019-06-11)
- Add
--force-output
option to force generation of diff file (#118 @clecat) - Support OCaml 4.08.0 (#121 @xclerc)
- README and documentation fixes (#122 #118 @andreypopp @clecat @samoht)
- Use latest ocaml-migrate-parsetree interfaces (@avsm)
1.3.0 (2019-03-01)
- Updated readme file with the new features: dune rules, named environment and ocaml versions, Some grammar correction too (@gpetiot, #101, aantron, #102)
- Better lexer error messages (@avsm, #103)
- Added cram syntax parsing (@trefis, #106)
- Renamed mdx to ocaml-mdx to avoid conflicts/for more precision (@clecat, #110, #115)
- Fix blank spaces causing parsing errors (@gpetiot, #97)
- Fix empty lines causing a String.sub (@clecat, #107)
1.2.0 (2018-01-03)
- Support end-of-line ellipsis (@dra27, #85)
- Support OCaml 4.02.3 (@gpetiot, #86)
- Support
version=..
,version<=..
andversion>=..
keywords to run a code-block depending on the currently installed OCaml version (@gpetiot, #87, #90) - Upgrade Travis tests to use opam 2.0.2 (@avsm, #89)
- Do not depend on
ppx_tools
for toplevel (@avsm, #89) - Fix embedding in a larger Dune project with a cppo override (@avsm, #89)
mdx output
: escape HTML entities in code blocks (#91, @samoht)
1.1.0 (2018-11-16)
- Add a mechanism to promote files to blocks and blocks to file (@gpetiot, #37)
- Support multiple toplevel environments (@gpetiot, #38)
- Use ocaml-migrate-parsetree to compile in 4.06.1 & 4.07.0 (@gpetiot, #41)
- Add a
mdx rule
command to generate dune rules (@gpetiot, #44) - Add a
mdx output
command to generate an HTML document (@samoht, #45) - Support empty code blocks (@samoht, #46)
- Fix detection of OCaml code/toplevel (@samoht, #47)
- Better handling of multi-line shell scripts (@samoht, #48)
- Fix regression in toplevel blocks when creating newtype (@samoht, #49)
- Fix evaluation of non-determinitic test (@samoht, #50)
- Improve mdx rules to take into account more precise dependencies (@samoht, #51)
- Fix promotion of blocks to complete ML files (@samoht, #52)
- mdx does not use the
cppo
library, just the binary (@samoht, #53) - fix ellipsis in code blocks (@samoht, #57)
- Fix relative paths for promoted blocks to files (@samoht, #58)
- Fix location of errors for multi-line commands (@samoht, #60)
- improve the parser for shell blocks (@samoht, #61)
- Allow to load preludes in specific environments (@samoht, #63)
- Fix evaluation of code after directives in prelude (@samoht, #64)
- Improve promotion to ml files (@samoht, #66)
- mdx rule: generates (source_tree) dependencies for directory metadata (@samoht, #67)
- Fix handling of 'module type' in multiple toplevel environment (@samoht, #68)
- Add an eval=false label to skip the evaluation of a code block (@samoht, #69)
- Fix parsing of shell blocks with multiple exit codes (@samoht, #71)
- Support source-tree as extra block metadata (@samoht, #72)
- Better formatting of non-compiling promoted contents (@samoht, #73)
- Be sure to remove the .corrected files if the promotion to ML file works (mdx74)
- Add missing dependency in test/dune (@samoht, #75)
- Support
dir=..
labels in ml code blocks (@samoht, #76) - Allow to promote to mli files too (@samoht, #77)
- Support multi-line strings (@samoht, #78)
- fail (and exit 1) if prelude and ml blocks cannot be evaluated properly (@samoht, #80, @samoht, #83)
- Allow to pass --root to
mdx rule
(@samoht, #81) - mdx rule: do not add (package mdx) in the dependencies (@samoht, #82)
1.0.0 (2018-09-23)
- Initial release
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
On This Page