Skip to content

Tool for automatic updates of code snippets in README.md or in other *.md files directly from source code.

Notifications You must be signed in to change notification settings

profiprog/update-code-snippets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple tool for updating code snippets in README.md or in other .md files directly from project codes.

Currently supports just typescript. Other languages will be added as needed.

Install

$ npm install -D update-code-snippets

Usage

Tool can be used together with husky to automatically update code snippets in README.md before every commit.

In package.json set up:

{ 
  "scripts": {
    "precommit": "update-code-snippets"
  },
  "devDependencies": {
    "husky": "^0.14.3",
    "update-code-snippets": "^1.0.0"
  }
}

About

Tool for automatic updates of code snippets in README.md or in other *.md files directly from source code.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •