https://github.com/bconnorwhite/write-md-safe
Write markdown files from a Marked token list or string
https://github.com/bconnorwhite/write-md-safe
filesystem markdown markdown-parser marked-js node nodejs typescript
Last synced: 3 months ago
JSON representation
Write markdown files from a Marked token list or string
- Host: GitHub
- URL: https://github.com/bconnorwhite/write-md-safe
- Owner: bconnorwhite
- Created: 2020-09-07T02:59:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-13T13:29:11.000Z (almost 5 years ago)
- Last Synced: 2025-03-03T18:46:25.104Z (11 months ago)
- Topics: filesystem, markdown, markdown-parser, marked-js, node, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 718 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
write-md-safe
> Write markdown files from a [Marked](https://www.npmjs.com/package/marked) token list or string.
## Installation
```bash
yarn add write-md-safe
```
```bash
npm install write-md-safe
```
## API
### Types
```ts
import {
writeMarkdown,
writeMarkdownSync,
markdownContentToString,
MarkdownContent,
Token, // a Marked token
Tokens,
Options
} from "write-md-safe";
function writeMarkdown(path: string, content?: MarkdownContent, options?: Options): Promise;
function writeMarkdownSync(path: string, content?: MarkdownContent, options?: Options): void;
function markdownContentToString(content?: MarkdownContent): string;
type MarkdownContent = string | (Token | string)[];
type Options = {
/**
* Recursively create parent directories if needed. Default: `true`
*/
recursive?: boolean;
/**
* Ensure file ends with a newline. Default: `true`
*/
appendNewline?: boolean;
/**
* Write even if file already exists. Default: `true`
*/
overwrite?: boolean;
}
```
Dependencies
- [marked](https://www.npmjs.com/package/marked): A markdown parser built for speed
- [write-file-safe](https://www.npmjs.com/package/write-file-safe): Write files and create parent directories if necessary
Dev Dependencies
- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for TypeScript projects
- [@types/marked](https://www.npmjs.com/package/@types/marked): TypeScript definitions for Marked
- [@types/mock-fs](https://www.npmjs.com/package/@types/mock-fs): TypeScript definitions for mock-fs
- [mock-fs](https://www.npmjs.com/package/mock-fs): A configurable mock file system. You know, for testing.
- [read-file-safe](https://www.npmjs.com/package/read-file-safe): Read files without try catch
License 
[MIT](https://mit-license.org/)
## Related Packages:
- [read-md-safe](https://npmjs.com/package/read-md-safe): Read markdown files as a Marked token list or string.
- [write-file-safe](https://www.npmjs.com/package/write-file-safe): Write files, and create parent directories if necessary.