{"repo":"szkiba/mdcode","free":true,"listed":false,"github":"https://github.com/szkiba/mdcode","clone":"git clone https://github.com/szkiba/mdcode.git","description":"Markdown code block authoring tool","language":"Go","stars":28,"topics":["documentation-testing","markdown","testing"],"license":"MIT","category":"dev-tools","readme_excerpt":"ｍｄｃｏｄｅ Markdown code block authoring tool The mdcode command-line tool allows code blocks embedded in a markdown document to be developed in the usual way. During the development of the code blocks, the usual tools and methods can be used. This makes the embedded codes testable, which is especially important for example codes. There is no worse developer experience than a faulty sample code. Here is a simple example code for a factorial calculation: go JavaScript At first glance, there is nothing special about this. However, these code blocks are testable! This document includes the necessary code for testing within invisible code blocks. By examining the source of this document, you can observe how effortlessly code blocks, even invisible ones, can be embedded using mdcode . Code blocks embedded in this document can be saved to files using the mdcode extract command. A README test.go and a README.test.js file will be created in the current directory. After modification, the code blocks can be updated from these files to the document using the mdcode update command. After the modification, it is advisable to test the above examples using the following commands: Since the above code block has a name ( test ), it can also be run with the mdcode run command: More examples can be found in the examples directory and in the tutorial. Features - include source files as code blocks in the markdown document - update the code blocks in the markdown document - save markdown code blocks ","default_branch":null,"files":null,"tree":[],"storefront":"/r/szkiba","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/szkiba/mdcode/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}