https://github.com/lijinke666/bookmark

:closed_book: generator bookmark form the directory
https://github.com/lijinke666/bookmark

bookmark cli generator gh-pages

Last synced: 27 days ago
JSON representation

:closed_book: generator bookmark form the directory

• Host: GitHub
• URL: https://github.com/lijinke666/bookmark
• Owner: lijinke666
• License: mit
• Created: 2018-06-29T08:45:08.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-11T08:40:50.000Z (almost 3 years ago)
• Last Synced: 2024-12-10T11:25:22.529Z (about 1 month ago)
• Topics: bookmark, cli, generator, gh-pages
• Language: JavaScript
• Homepage:
• Size: 206 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bookmark

[![npm](https://img.shields.io/npm/dm/j-bookmark.svg?style=flat-square)](https://www.npmjs.com/package/j-bookmark)

[![npm version](https://img.shields.io/npm/v/j-bookmark.svg?style=flat-square)](https://badge.fury.io/js/j-bookmark)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://www.npmjs.com/package/j-bookmark)

:closed_book: generator bookmark form the directory

You can quickly generate a directory page.

For example, there are many HTML pages in the folder, use bookmark build your `index.html`, Then in gh-pages use it

## Installation

```bash

yarn global add j-bookmark

// npm install j-bookmark -g

```

## Usage

```bash

[bm | bookmark] 

```

## Example

```js

src

├── test

│   └── a.html

└── test.html

```

```bash

bm -d /path/to/xx -o /page/to/xx -p /path

```

```bash

$ bm -d src

# output



  


    1. test.html

  

  


    2. a.html

  



```


```bash

$ bm -d src -p /prefix

# output



  


    1. test.html

  

  


    2. a.html

  



```


```bash

$ bm -d src --ignore **/test/**

# output



  


    1. test.html

  



```


```bash

$ bm -d src -o output.html

# output

├── output.html

├── test

│   └── a.html

└── test.html

```

## Commands

```bash

  -v, --version            output the version number

  -d --directory [value]   entry directory (default: process.cwd())

  -o --output [value]      output directory (default: process.cwd() + index.html)

  -p --publicPath [value]  output public path (default: '')

  -i --ignore [value]      Add a pattern or an array of glob patterns to exclude matches (default: node_modules) //https://github.com/isaacs/node-glob#options

  -h, --help               output usage information

  --disableAnimate         Disable bookmark animate (default: false)

```

## Development

```bash

git clone https://github.com/lijinke666/bookmark.git

npm install | yarn

npm link

```

## Test Case

```bash

npm run test

```

## License

[MIT](https://github.com/lijinke666/bookmark/blob/master/LICENCE)