# itcastmd

> a npm wrapper for convert markdown to html by itcast fe

Latest version **1.1.3** (published 2023-11-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install itcastmd
pnpm add itcastmd
yarn add itcastmd
bun add itcastmd
```

Provides the command `itcastmd`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2023-11-12 |
| First published | 2016-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 725.8 KB |
| Known vulnerabilities | 0 (+15 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | malun666 |
| Maintainers | malun |
| Keywords | doc, markdown, md, itcast, table of content, ztree, html |

## Links

- npm: https://www.npmjs.com/package/itcastmd
- Repository: https://github.com/malun666/itcastmd
- Issues: https://github.com/malun666/itcastmd/issues
- npm.io page: https://npm.io/package/itcastmd

## Dependencies (8)

- [open](https://npm.io/package/open.md) 0.0.5
- [config](https://npm.io/package/config.md) ^1.7.0
- [marked](https://npm.io/package/marked.md) ^0.3.2
- [shelljs](https://npm.io/package/shelljs.md) ^0.3.0
- [commander](https://npm.io/package/commander.md) ^2.5.0
- [handlebars](https://npm.io/package/handlebars.md) ^2.0.0
- [bufferhelper](https://npm.io/package/bufferhelper.md) ^0.2.0
- [object-assign](https://npm.io/package/object-assign.md) ^1.0.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.1.3 (latest) — 2023-11-12
- 1.1.2 — 2016-07-06
- 1.1.1 — 2016-07-06

## README

itcastmd 
=========

itcastmd is an npm tool that converts Markdown files into an HTML website.

[中文文档](./CHINESE.md)

## Preview 

![](https://github.com/i5ting/i5ting_ztree_toc/blob/master/demo/3.png)

## Install 

	npm install -g itcastmd
	
## Usage

```shell
itcastmd -f sample.md -o
```

This version of the command is relatively simple, with only one -f parameter. If not specified, it defaults to using README.md.

```
  Options:
    -h, --help             output usage information
    -V, --version          output the version number
    -f, --file [filename]  default is README.md 
		-o, --open             open in browser
    -v, --verbose          print the logs
```


	
## Api Usages

Example:

```
var is_open = true;
var markd_config = {
	debug: false
}
var pwd = process.cwd()  

var source_file_name = pwd + '/' + source_file
var file_name = source_file_name.split('/').pop();;
var _file_name = file_name.split('.')[0];

var dest_file_path = pwd + '/preview/' + _file_name + '.html';

console.log('pwd=' + pwd);
console.log('source_file_name=' + source_file_name);
console.log('dest_file_path=' + dest_file_path);

require('../index')(pwd, source_file_name, dest_file_path, is_open, markd_config);

```

Parameter Descriptions:

- pwd: The location where the preview is stored.
- source_file: The Markdown file to be compiled.
- dest_file_path: The complete path and filename for the generated HTML.
- is_open: Indicates whether to open the HTML in a browser after compilation.
- markd_config: Compilation options for Markdown (refer to https://github.com/chjj/marked for specifics).

## Basic

current path

	var pwd = process.cwd()


file path 

	__dirname
	
	
use shelljs judge dir is

	if (test('-d', previewPath)) { 
		/* do something with dir */ 
		mkdir('-p', previewPath);
	};
	
http://documentup.com/arturadib/shelljs

- '-b', 'path': true if path is a block device
- '-c', 'path': true if path is a character device
- '-d', 'path': true if path is a directory
- '-e', 'path': true if path exists
- '-f', 'path': true if path is a regular file
- '-L', 'path': true if path is a symboilc link
- '-p', 'path': true if path is a pipe (FIFO)
- '-S', 'path': true if path is a socket

template for compile use [handlebars](http://handlebarsjs.com/)


## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## Recommend

- [mac-dev-setup](http://aaaaaashu.gitbooks.io/mac-dev-setup/content/index.html)
- [How To Build A CLI Tool With Node.js And PhantomJS](http://www.smashingmagazine.com/2014/02/12/build-cli-tool-nodejs-phantomjs/)

## Version History

- v0.1.0

## Welcome Fork and Comment

- write by  malun666@126.com

If you have suggestions or feedback, please raise an issue or send an email.

## License

this repo is released under the [MIT
License](./license).

---
_Source: https://npm.io/package/itcastmd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._