Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

codemd

pangrr2ISC1.1.0

a tool that helps writing code in markdown files

readme

Build Status

a tool that helps writing code in md files

how to use

  1. Write a code md file with code sewed in documentation. hello.js.md:

     This code is to print "hello" in the console.
     ```js
     function hello () {
         console.log("hello");
     }
     ```
  2. Run codemd gencode <path...> to generate or update code files from code md files.

  3. Test your code.

  4. Run codemd delcode <path...> to delete code files. So that your project keeps only the code md files.

todos

  • 1.1.0
    • implement codemd delcode <path...>
    • implement codemd gencode <path...>