|
1 | | -# Gettings started with coulson |
| 1 | +# Gettings started with scully |
2 | 2 |
|
3 | | -In an existing Angular app, first install coulson by using the CLI: |
| 3 | +In an existing Angular app, first install scully by using the CLI: |
4 | 4 |
|
5 | 5 | ```bash |
6 | | -ng add @herodevs/coulson-generate --blog |
| 6 | +ng add @herodevs/scully-generate --blog |
7 | 7 | ``` |
8 | 8 |
|
9 | 9 |
|
10 | 10 | When that is done, the following things will have happened. |
11 | 11 |
|
12 | 12 | 1. We installed all the dependencies most of those are only developer dependencies. |
13 | | -2. We added a `coulson.json` sample configuration. |
| 13 | +2. We added a `scully.json` sample configuration. |
14 | 14 |
|
15 | 15 |
|
16 | 16 | The `--blog` is optional and will add the below in one step. |
17 | 17 |
|
18 | 18 | 1. add a folder `./blog` to the project root. |
19 | 19 | 2. add a lazy loaded blog module to your app. |
20 | 20 | 3. put in a sample route to this module |
21 | | -4. added a blog component, that shows how to sue the `<coulson-content>` component |
| 21 | +4. added a blog component, that shows how to sue the `<scully-content>` component |
22 | 22 | 5. put in a sample mardown first blog entry in the folder |
23 | 23 |
|
24 | 24 | You can do this later on by using: |
25 | 25 |
|
26 | 26 | ```bash |
27 | | -ng generate @herodevs/coulson-generate:blog |
| 27 | +ng generate @herodevs/scully-generate:blog |
28 | 28 | ``` |
29 | 29 |
|
30 | 30 | To add a page to the blog you can use: |
31 | 31 |
|
32 | 32 | ```bash |
33 | | -ng g @herodevs/coulson-generate:post --title=MyBeautifulWebApp |
| 33 | +ng g @herodevs/scully-generate:post --title=MyBeautifulWebApp |
34 | 34 | ``` |
35 | 35 |
|
36 | 36 | This will create a new MD file in the `./blog` folder. if you provided the optional `--title` option, it will use the name given, otherwise it will create a file named `blogxxx.md` where xxx is a number. it warns when the file already exists. |
37 | 37 |
|
38 | 38 | A blog file will start with an header. We are using the standard [front-matter](https://github.com/jxson/front-matter) to extract this header. |
39 | | -The meta-data available in there will be available to you by injecting the `CoulsonRoutesService` |
| 39 | +The meta-data available in there will be available to you by injecting the `ScullyRoutesService` |
40 | 40 |
|
41 | 41 |
|
42 | | -Now you are ready run the coulson you can do this by: |
| 42 | +Now you are ready run the scully you can do this by: |
43 | 43 |
|
44 | 44 | ```bash |
45 | | -npm run coulson:generate |
| 45 | +npm run scully:generate |
46 | 46 | ``` |
47 | 47 | When are done with this, inside your dist folder is a static folder, with all pages generated. |
48 | 48 |
|
|
0 commit comments