Skip to content

Commit

Permalink
chore: rename package to pdf-generator
Browse files Browse the repository at this point in the history
  • Loading branch information
yndx-birman committed Jun 6, 2024
1 parent 77743a3 commit 7a31258
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# docs2pdf
# pdf-generator

Package to turn Diplodoc projects into PDFs.

## Installation

```
npm i -g @diplodoc/docs2pdf
npm i -g @diplodoc/pdf-generator
```

## Usage
Expand All @@ -20,10 +20,10 @@ npx -- @diplodoc/cli@latest -i ./docs -o ./docs-output --single-page

### Step 2: Convert Single Page Files to PDFs

Run the `@diplodoc/docs2pdf` command. This will create PDF files right next to the single page ones.
Run the `@diplodoc/pdf-generator` command. This will create PDF files right next to the single page ones.

```
npx -- @diplodoc/docs2pdf@latest -i ./docs-output
npx -- @diplodoc/pdf-generator@latest -i ./docs-output
```

## Development
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@diplodoc/docs2pdf",
"name": "@diplodoc/pdf-generator",
"version": "0.1.0",
"description": "Package to turn Diplodoc projects into PDFs",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/diplodoc-platform/docs2pdf"
"url": "https://github.com/diplodoc-platform/pdf-generator"
},
"bin": {
"docs2pdf": "build/cmd/index.js"
"pdf-generator": "build/cmd/index.js"
},
"main": "build/index.js",
"files": [
Expand Down
2 changes: 1 addition & 1 deletion src/cmd/generate/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function builder<T>(argv: Argv<T>) {
'Syntax: https://en.wikipedia.org/wiki/Glob_(programming)#Syntax',
type: 'array',
})
.example('docs2pdf -i ./input', '')
.example('pdf-generator -i ./input', '')
.demandOption(['input'], 'Please provide input argument to work with this tool');
}

Expand Down

0 comments on commit 7a31258

Please sign in to comment.