-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update cli readme guideline (#464)
- Loading branch information
Showing
4 changed files
with
61 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# md-cli | ||
|
||
A powerful yet simple tool for rendering Markdown documents locally during development. | ||
|
||
## Installation | ||
|
||
To get started with `md-cli`, you can install it either globally or locally, depending on your needs. | ||
|
||
### Install locally | ||
|
||
If you only need it for a specific project, you can install it locally by running: | ||
|
||
```bash | ||
npm install @doocs/md-cli | ||
``` | ||
|
||
### Install globally | ||
|
||
For global access across all your projects, install it globally with: | ||
|
||
```bash | ||
npm install -g @doocs/md-cli | ||
``` | ||
|
||
## Usage | ||
|
||
Once installed, running `md-cli` is a breeze. Here’s how to get started: | ||
|
||
### Default setup | ||
|
||
To launch `md-cli` with the default settings, simply run: | ||
|
||
```bash | ||
md-cli | ||
``` | ||
|
||
### Custom port | ||
|
||
If you prefer to run `md-cli` on a different port, say `8899`, just specify it like this: | ||
|
||
```bash | ||
md-cli port=8899 | ||
``` | ||
|
||
## Maintainers | ||
|
||
- [yanglbme](https://github.com/yanglbme) – Core maintainer. | ||
- [YangFong](https://github.com/yangfong) – Core maintainer. | ||
- [xw](https://github.com/wll8) – Contributor. | ||
- [thinkasany](https://www.npmjs.com/~thinkerwing) – Contributor. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters