Skip to content

Commit

Permalink
docs(repo): added documentation for workspace details
Browse files Browse the repository at this point in the history
  • Loading branch information
sridharmallela committed Jan 20, 2025
1 parent 5094922 commit 167761f
Show file tree
Hide file tree
Showing 9 changed files with 144 additions and 155 deletions.
29 changes: 16 additions & 13 deletions docs/commitlint-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: 'CommitLint Config'
permalink: '/commitlint-config'
---

[![npm](https://img.shields.io/npm/v/commitlint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/commitlint-config-smallela) [![npm](https://img.shields.io/npm/dw/commitlint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/commitlint-config-smallela) [![npm](https://img.shields.io/npm/dm/commitlint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/commitlint-config-smallela) [![npm](https://img.shields.io/npm/dy/commitlint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/commitlint-config-smallela) [![npm](https://img.shields.io/npm/dt/commitlint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/commitlint-config-smallela)

[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/smallela-workspace/main/LICENSE)

This package is a [`commitlint`](https://github.com/conventional-changelog/commitlint) configuration for commit message conventions and enforcement. It's a modified variation of [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/config-conventional), with the following enhancements:

- Commit message header-length is extended to 80 characters, _provoked by lengthy Greenkeeper's commit message subject lines_.
Expand All @@ -12,19 +16,18 @@ This package is a [`commitlint`](https://github.com/conventional-changelog/commi

<!-- TOC -->

- [Commitlint Config](#commitlint-config)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Using package.json file](#using-packagejson-file)
- [Using .commitlintrc.json file](#using-commitlintrcjson-file)
- [Using .commitlintrc.yml file](#using-commitlintrcyml-file)
- [Using commitlint.config.js, .commitlintrc.js file](#using-commitlintconfigjs-commitlintrcjs-file)
- [Custom Configuration](#custom-configuration)
- [Using JSON](#using-json)
- [Using YAML](#using-yaml)
- [Using JavaScript](#using-javascript)
- [License](#license)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Using package.json file](#using-packagejson-file)
- [Using .commitlintrc.json file](#using-commitlintrcjson-file)
- [Using .commitlintrc.yml file](#using-commitlintrcyml-file)
- [Using commitlint.config.js, .commitlintrc.js file](#using-commitlintconfigjs-commitlintrcjs-file)
- [Custom Configuration](#custom-configuration)
- [Using JSON](#using-json)
- [Using YAML](#using-yaml)
- [Using JavaScript](#using-javascript)
- [License](#license)

<!-- /TOC -->

Expand Down
13 changes: 13 additions & 0 deletions docs/eslint-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ title: 'ESLint Config'
permalink: '/eslint-config'
---

[![npm](https://img.shields.io/npm/v/eslint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/eslint-config-smallela) [![npm](https://img.shields.io/npm/dw/eslint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/eslint-config-smallela) [![npm](https://img.shields.io/npm/dm/eslint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/eslint-config-smallela) [![npm](https://img.shields.io/npm/dy/eslint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/eslint-config-smallela) [![npm](https://img.shields.io/npm/dt/eslint-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/eslint-config-smallela)

[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/smallela-workspace/main/LICENSE)

## Table of Contents

<!-- TOC -->

- [Table of Contents](#table-of-contents)
- [License](#license)

<!-- /TOC -->

## License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Expand Down
15 changes: 9 additions & 6 deletions docs/jest-preset.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,21 @@ title: 'Jest Preset'
permalink: '/jest-prest'
---

[![npm](https://img.shields.io/npm/v/jest-preset-smallela.svg?style=plastic)](https://www.npmjs.com/package/jest-preset-smallela) [![npm](https://img.shields.io/npm/dw/jest-preset-smallela.svg?style=plastic)](https://www.npmjs.com/package/jest-preset-smallela) [![npm](https://img.shields.io/npm/dm/jest-preset-smallela.svg?style=plastic)](https://www.npmjs.com/package/jest-preset-smallela) [![npm](https://img.shields.io/npm/dy/jest-preset-smallela.svg?style=plastic)](https://www.npmjs.com/package/jest-preset-smallela) [![npm](https://img.shields.io/npm/dt/jest-preset-smallela.svg?style=plastic)](https://www.npmjs.com/package/jest-preset-smallela)

[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/smallela-workspace/main/LICENSE)

An opinionated [Jest preset](http://facebook.github.io/jest/docs/en/configuration.html#preset-string)

## Table of Contents

<!-- TOC -->

- [Jest Preset](#jest-preset)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Extending the preset provided configuration](#extending-the-preset-provided-configuration)
- [License](#license)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Extending the preset provided configuration](#extending-the-preset-provided-configuration)
- [License](#license)

<!-- /TOC -->

Expand Down
13 changes: 13 additions & 0 deletions docs/npm-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ title: 'npm Commands'
permalink: '/npm-commands'
---

[![npm](https://img.shields.io/npm/v/npm-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/npm-commands-smallela) [![npm](https://img.shields.io/npm/dw/npm-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/npm-commands-smallela) [![npm](https://img.shields.io/npm/dm/npm-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/npm-commands-smallela) [![npm](https://img.shields.io/npm/dy/npm-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/npm-commands-smallela) [![npm](https://img.shields.io/npm/dt/npm-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/npm-commands-smallela)

[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/smallela-workspace/main/LICENSE)

## Table of Contents

<!-- TOC -->

- [Table of Contents](#table-of-contents)
- [License](#license)

<!-- /TOC -->

## License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Expand Down
13 changes: 13 additions & 0 deletions docs/nx-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@ title: 'Nx Commands'
permalink: '/nx-commands'
---

[![npm](https://img.shields.io/npm/v/nx-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/nx-commands-smallela) [![npm](https://img.shields.io/npm/dw/nx-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/nx-commands-smallela) [![npm](https://img.shields.io/npm/dm/nx-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/nx-commands-smallela) [![npm](https://img.shields.io/npm/dy/nx-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/nx-commands-smallela) [![npm](https://img.shields.io/npm/dt/nx-commands-smallela.svg?style=plastic)](https://www.npmjs.com/package/nx-commands-smallela)

[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/smallela-workspace/main/LICENSE)

## Table of Contents

<!-- TOC -->

- [Table of Contents](#table-of-contents)
- [License](#license)

<!-- /TOC -->

## License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Expand Down
5 changes: 4 additions & 1 deletion docs/prettier-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ title: 'Prettier Config'
permalink: '/prettier-config'
---

[![npm](https://img.shields.io/npm/v/prettier-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/prettier-config-smallela) [![npm](https://img.shields.io/npm/dw/prettier-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/prettier-config-smallela) [![npm](https://img.shields.io/npm/dm/prettier-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/prettier-config-smallela) [![npm](https://img.shields.io/npm/dy/prettier-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/prettier-config-smallela) [![npm](https://img.shields.io/npm/dt/prettier-config-smallela.svg?style=plastic)](https://www.npmjs.com/package/prettier-config-smallela)

[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/smallela-workspace/main/LICENSE)

A **[Prettier](https://prettier.io/)** [shareable config](https://prettier.io/docs/en/configuration.html#sharing-configurations) for web projects.

## Table of Contents

<!-- TOC -->

- [Prettier Config](#prettier-config)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
Expand Down
35 changes: 6 additions & 29 deletions docs/print-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ permalink: '/print-cli'

[![npm](https://img.shields.io/npm/v/print-cli.svg?style=plastic)](https://www.npmjs.com/package/print-cli) [![npm](https://img.shields.io/npm/dw/print-cli.svg?style=plastic)](https://www.npmjs.com/package/print-cli) [![npm](https://img.shields.io/npm/dm/print-cli.svg?style=plastic)](https://www.npmjs.com/package/print-cli) [![npm](https://img.shields.io/npm/dy/print-cli.svg?style=plastic)](https://www.npmjs.com/package/print-cli) [![npm](https://img.shields.io/npm/dt/print-cli.svg?style=plastic)](https://www.npmjs.com/package/print-cli)

[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/print-cli.svg?style=plastic)](https://github.com/sridharmallela/print-cli/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/print-cli.svg?style=plastic)](https://github.com/sridharmallela/print-cli/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/print-cli.svg?style=plastic)](https://github.com/sridharmallela/print-cli/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/print-cli.svg?style=plastic)](https://github.com/sridharmallela/print-cli/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/print-cli/main/LICENSE)
[![GitHub tag](https://img.shields.io/github/tag/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/tags) [![GitHub release](https://img.shields.io/github/release/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/releases) [![GitHub issues](https://img.shields.io/github/issues/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/issues) [![GitHub pull requests](https://img.shields.io/github/issues-pr/sridharmallela/smallela-workspace.svg?style=plastic)](https://github.com/sridharmallela/smallela-workspace/pulls) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=plastic)](https://raw.githubusercontent.com/sridharmallela/smallela-workspace/main/LICENSE)

Generate a printable representation of ASCII text. Thanks to [Figlet](https://www.npmjs.com/package/figlet). Try it [here](http://patorjk.com/software/taag/#p=display&f=Graffiti&t=Type%20Something%20)

Expand All @@ -18,33 +18,18 @@ Generate a printable representation of ASCII text. Thanks to [Figlet](https://ww

- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Global CLI](#global-cli)
- [Non CLI](#non-cli)
- [Usage](#usage)
- [Non CLI](#non-cli)
- [NPM Script](#npm-script)
- [Options](#options)
- [enableBanner -b|--banner](#enablebanner--b--banner)
- [font -f|--font](#font--f--font)
- [color -c|--color](#color--c--color)
- [background color --bg-color](#background-color---bg-color)
- [Updating print-cli](#updating-print-cli)
- [License](#license)

<!-- /TOC -->

## Installation

### Global CLI

```bash
$ npm i -g print-cli
```

### Non CLI

```bash
$ npm i print-cli
$ npm i --save-dev print-cli
```

## Usage
Expand Down Expand Up @@ -109,11 +94,11 @@ $ npm run print-banner
### Options
#### enableBanner (-b|--banner)
`enableBanner (-b|--banner)`
- specifies to enable ASCII banner
#### font (-f|--font)
`font (-f|--font)`
- specifies font used to print the banner
- standard (default)
Expand All @@ -124,7 +109,7 @@ $ npm run print-banner
![Fonts-Usage](/assets/img/print-cli/fonts.gif)
#### color (-c|--color)
`color (-c|--color)`
- specifies color of the text being printed
- blue
Expand All @@ -142,7 +127,7 @@ $ npm run print-banner
![Colors-Usage](/assets/img/print-cli/colors.gif)
#### background color (--bg-color)
`background color (--bg-color)`
- specifies background color of the printed text
- bgBlack
Expand All @@ -156,14 +141,6 @@ $ npm run print-banner
![Background-Colors-Usage](/assets/img/print-cli/bg-colors.gif)
## Updating print-cli
Global package:
```bash
npx latest
```
## License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Expand Down
Loading

0 comments on commit 167761f

Please sign in to comment.