This repository has been archived by the owner on May 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Kaustav | #56 | Bumped up documentation version to 0.4. | TG-56
- Loading branch information
Showing
2 changed files
with
73 additions
and
0 deletions.
There are no files selected for viewing
72 changes: 72 additions & 0 deletions
72
docusaurus/website/versioned_docs/version-0.4/cli-command-generate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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", | ||
|