You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cli/recipes.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@ Amber generators can use a recipe to generate your application, and scaffold you
6
6
7
7
### Recipe contributors
8
8
9
-
Recipes are provided by independent contributors in their own github accounts. To use a recipe you specify the github account name and recipe name in the format _githubaccount/recipe_name_.
10
-
Recipe creators should add the **amber-recipe** topic to the github repository for the recipe.
9
+
Recipes are provided by independent contributors in their own GitHub accounts. To use a recipe you specify the GitHub account name and recipe name in the format _githubaccount/recipe_name_.
10
+
Recipe creators should add the **amber-recipe** topic to the GitHub repository for the recipe.
11
11
12
12
### Available recipes
13
13
14
-
See the [Amber Recipes](https://github.com/topics/amber-recipe) that are available on github for a list
14
+
See the [Amber Recipes](https://github.com/topics/amber-recipe) that are available on GitHub for a list
15
15
of recipes that have been created by recipe contributors. Visit the recipe repository for more information about each recipe.
16
16
17
17
### Amber New Command with a recipe
@@ -44,7 +44,7 @@ Options:
44
44
45
45
### Example Usage
46
46
47
-
Using `amber new microsecond-blog -r damianham/amber_modular` will generate a skeleton Amber application in `./microsecond-blog` using the _amber_modular_ recipe that was provided by the github user _damianham_.
47
+
Using `amber new microsecond-blog -r damianham/amber_modular` will generate a skeleton Amber application in `./microsecond-blog` using the _amber_modular_ recipe that was provided by the GitHub user _damianham_.
48
48
49
49
You can have a running web application in a matter of minutes:
50
50
@@ -98,7 +98,7 @@ Once an application is generated with a recipe, it will be used by future genera
98
98
### Custom Recipe
99
99
100
100
When a recipe doesn't quite suite your requirements, it's easy to modify. Recipes are application stubs written in [Liquid](https://github.com/TechMagister/liquid.cr).
101
-
Modified recipes can be stored and sourced locally or made available to other Amber users from your own github account.
101
+
Modified recipes can be stored and sourced locally or made available to other Amber users from your own GitHub account.
102
102
103
103
Download a recipe that you want to modify, extract it, and use the extracted recipe on the command line. For example:
104
104
@@ -115,10 +115,10 @@ It is important to give the absolute path to the recipe folder as the recipe com
115
115
116
116
### Contributing your recipe
117
117
118
-
The best way to do this is to fork an existing recipe and then modify it. Visit the github repository of a recipe you want to use as a starting point, e.g. one of the recipes listed above in the **Available recipes** section, and create your own fork. After you have modified the recipe and pushed your changes you can create apps with your recipe with:
118
+
The best way to do this is to fork an existing recipe and then modify it. Visit the GitHub repository of a recipe you want to use as a starting point, e.g. one of the recipes listed above in the **Available recipes** section, and create your own fork. After you have modified the recipe and pushed your changes you can create apps with your recipe with:
119
119
120
120
```
121
121
amber new myapp -r your_github_name/your_recipe_name
122
122
```
123
123
124
-
You can easily contribute your recipe to the Amber community. Create a fork of [amber-docs](https://github.com/amberframework/docs), edit this page to add your recipe to the **Available recipes** section and submit a Pull Request.
124
+
You can easily contribute your recipe to the Amber community. By adding the **amber-recipe** topic to your recipe repository on GitHub, it will be added to the list of [Amber Recipes](https://github.com/topics/amber-recipe).
0 commit comments