update-markdown

1.1.3 • Public • Published

update-markdown

Updates part of existing markdown document

update-markdown-icon

Build status dependencies devdependencies

install and use

npm install -g update-markdown

If a file filename.md exists with the following contents

# title
some text
## foo
this is foo
## bar
this is bar

and another file new.md with new text for section ## foo we can replace it using

cat new.md | um filename.md "## foo"

updating the filename.md to have

# title
some text
## foo
<content from new.md>
## bar
this is bar

You can also specify new content from another markdown file, same command as above will be

um filename.md "## foo" new.md

Want to see it in action? Check out the list of 3rd party modules below - we are generating it using the modules-used tool in build script in the package.json.

"scripts"{
  "3rd-party": "modules-used | um README.md '### 3rd party modules'"
}

3rd party modules

  • bluebird - Full featured Promises/A+ implementation with exceptionally good performance
  • check-more-types - Large collection of predicates
  • debug - small debugging utility
  • get-stdin-promise - Return stdin as a promise
  • lazy-ass - Lazy assertions without performance penalty
  • lodash - The modern build of lodash modular utilities.
  • marked - A markdown parser built for speed
  • marked-to-md - Markdown renderer for marked

Small print

Author: Gleb Bahmutov © 2015

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2015 Gleb Bahmutov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme

Keywords

Package Sidebar

Install

npm i update-markdown

Weekly Downloads

4

Version

1.1.3

License

MIT

Last publish

Collaborators

  • bahmutov