Skip to content
This repository has been archived by the owner on May 25, 2024. It is now read-only.

Commit

Permalink
Kaustav | #56 | Bumped up documentation version to 0.4. | TG-56
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenixTW committed Aug 22, 2019
1 parent ae35f05 commit 645525e
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
id: version-0.4-cli-command-generate
title: rg generate
original_id: cli-command-generate
---

Generates and/or modifies files based on a task.

rg **generate** `<task>` `<name>` [_options_]

rg **g** `<task>` `<name>` [_options_]

## Description

It generates the required element based on the task name.

> Note that, for now we are only supporting **component, style** generating task.
## Arguments

Argument | Description |
---------|----------|
_task_ | The task or collection of tasks to generate. Check the [currently supported tasks](#task-commands). |

## Options

Argument | Description |
---------|----------|
--style=scss | Generates specific stylesheet file along with the component. NOTE THAT: WE ARE ONLY SUPPORTING SCSS FILE FOR NOW. |
--help | Shows a help message for this command in the console. |

---

## Task commands

### Component

rg generate **component** `<name>` [_options_]

rg g **component** `<name>` [_options_]

#### Description

Creates a new generic component definition in the given or default project.

The component will be created in the current working directory.

#### Arguments

Argument | Description |
---------|----------|
_name_ | The name of the component. |

### Style

rg generate **style** `<name>` [_options_]

rg g **style** `<name>` [_options_]

#### Description

Creates a new stylesheet file in the given or default project.

The stylesheet will be created in the current working directory.

> WE ARE ONLY SUPPORTING `SCSS` FILE FOR NOW.
#### Arguments

Argument | Description |
---------|----------|
_name_ | The name of the stylesheet. |
1 change: 1 addition & 0 deletions docusaurus/website/versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[
"0.4",
"0.3.3",
"0.3.2",
"0.3.1",
Expand Down

0 comments on commit 645525e

Please sign in to comment.