https://github.com/agneym/create-profile-card

Create a Custom Profile Card CLI
https://github.com/agneym/create-profile-card

cli nodejs profile-card

Last synced: 6 months ago
JSON representation

Create a Custom Profile Card CLI

• Host: GitHub
• URL: https://github.com/agneym/create-profile-card
• Owner: agneym
• License: mit
• Created: 2018-12-23T17:10:18.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-05T13:07:02.000Z (about 1 year ago)
• Last Synced: 2024-09-19T09:47:48.787Z (about 1 year ago)
• Topics: cli, nodejs, profile-card
• Language: JavaScript
• Homepage:
• Size: 1.1 MB
• Stars: 6
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Create Profile Card

![npm](https://img.shields.io/npm/v/create-profile-card)

A CLI for creating a profile card package.

![Image of Profile Card](docs/terminal.png)

## Usage 

```

npm init profile-card name

```

![Steps](docs/steps.gif)

## Customising your card

Inside the generated project, you will find a `config.json` file. 

1. This contains keys for all data that you entered previously. Any change to this file will also change the profile card.

2. The key `boxOptions` contains default configuration for [boxen](https://github.com/sindresorhus/boxen) You can customise it providing any of its [options](https://github.com/sindresorhus/boxen#usage).

3. The key `textOptions` contains defaults for text styling using [chalk](https://github.com/chalk/chalk). You can provide any of the options from [styles](https://github.com/chalk/chalk#styles).

You can also combine options like:

```

{

  "textOptions": {

    "label": "bold.green",

    "value": "underline.redBright"

  }

}

```

## License

MIT - see LICENSE