Skip to content

Commit

Permalink
chore: Modify package.json & idoc config.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Apr 25, 2022
1 parent 2dc322e commit 58e00b6
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 7 deletions.
13 changes: 13 additions & 0 deletions idoc.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
site: "HTML To Markdown"

dir: packages

menus:
Home: index.html
CLI: cli/index.html

editButton:
label: Edit this page on GitHub
url: https://github.com/jaywcjlove/html-to-markdown-cli/blob/main/

footer: |
Released under the MIT License. Copyright © 2022 Kenny Wong<br />
Generated by <a href="https://github.com/jaywcjlove/idoc" target="_blank">idoc</a> v{{idocVersion}}
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"$schema": "https://json.schemastore.org/package.json",
"private": true,
"title": "html-to-markdown",
"version": "1.0.0",
"description": "",
"scripts": {
Expand Down
11 changes: 9 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
@wcj/html-to-markdown-cli
`@wcj/html-to-markdown-cli`
===

Command line tool for html conversion markdown.

## Quick Start

```bash
```shell
$ npx @wcj/html-to-markdown-cli ./html/index.html
# => # Markdown String
$ npx @wcj/html-to-markdown-cli https://jaywcjlove.github.io/idoc/
# => # Markdown String
```

Or

```shell
$ sudo npm i @wcj/html-to-markdown-cli -g
$ html-to-markdown ./html/index.html
# => # Markdown String
$ html-to-markdown https://jaywcjlove.github.io/idoc/
# => # Markdown String
```

## Command Help
Expand Down
1 change: 1 addition & 0 deletions packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"author": "jaywcjlove",
"type": "module",
"license": "MIT",
"repository": "https://github.com/jaywcjlove/html-to-markdown-cli/tree/main/packages/cli",
"bin": {
"html-to-markdown": "lib/cli.js"
},
Expand Down
11 changes: 8 additions & 3 deletions packages/html-to-markdown/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@wcj/html-to-markdown
`@wcj/html-to-markdown`
===

HTML conversion tool to markdown. command line tool => [`@wcj/html-to-markdown-cli`](../cli/README.md).
HTML conversion tool to markdown. command line tool => [`@wcj/html-to-markdown-cli`](https://npmjs.com/@wcj/html-to-markdown-cli).

## Installation

Expand All @@ -15,12 +15,17 @@ Command line tool

```shell
$ npx @wcj/html-to-markdown-cli ./html/index.html
# => # Markdown String
$ npx @wcj/html-to-markdown-cli https://jaywcjlove.github.io/idoc/
Or
# => # Markdown String

# Or

$ sudo npm i @wcj/html-to-markdown-cli -g
$ html-to-markdown ./html/index.html
# => # Markdown String
$ html-to-markdown https://jaywcjlove.github.io/idoc/
# => # Markdown String
```

## Usage
Expand Down
2 changes: 1 addition & 1 deletion packages/html-to-markdown/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/jaywcjlove/idoc.git"
"url": "https://github.com/jaywcjlove/html-to-markdown-cli.git"
},
"files": [
"lib",
Expand Down

0 comments on commit 58e00b6

Please sign in to comment.