Skip to content

Commit

Permalink
refactor(docs): fix minor errors
Browse files Browse the repository at this point in the history
* refactor(docs): add right links and minor fixes

* refactor(docs): add link to scully.md

* refactor(docs): links
  • Loading branch information
Villanuevand authored Dec 17, 2019
1 parent e19346c commit 65be7bc
Show file tree
Hide file tree
Showing 8 changed files with 53 additions and 17 deletions.
15 changes: 11 additions & 4 deletions docs/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,23 @@ If you don't want the folder to be called 'blog', you can run a longer command t
To name your blog folders and components another name, run the following command with your own name:

```bash
ng g @scullyio/init:markdown --name=cooking
ng g @scullyio/init:markdown --name=my-test --slug=my-slug-id
```

or

```bash
ng g @scullyio/init:markdown --name="my text" --slug="my slug id"
```


## Generating New Blog Posts

To add a new blog post, run the following command. T
To add a new blog post, run the following command.

```
ng g @scullyio/init:post --title
ng g @scullyio/init:post --name="This is my post"
```

---
Next: [Full Documentation ➡️](scully.md)
[Full Documentation ➡️](scully.md)
28 changes: 22 additions & 6 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scully - Getting Started

The first thing you need to get started with Scully is a working Angular app using Angular 8.* or 9.*.
The first thing you need to get started with Scully is a working Angular app using Angular 9.*.

This getting started doc covers the three steps to adding Scully into your project.

Expand All @@ -15,9 +15,25 @@ To install Scully, do the following: From the root directory of your Angular pro
ng add @scullyio/init
```

At this point, Scully has been added to your project. The most important part of the installation is the addition of the
Scully configuration file: `scully.config.js` (_soon this will be `scully.config.ts`_). To learn more about this file,
read [Scully Configuration](scully-configuration.md) docs.
The command above set up the necessary to start to work with Scully (_we go to get more deep about this in next releases._).

If the installation was success you can read a message similar to this one.

```bash
Installed packages for tooling via yarn.
✔ Added dependency
✔ Import HttpClientModule into root module
UPDATE package.json (1447 bytes)
UPDATE src/app/app.module.ts (472 bytes)
UPDATE src/polyfills.ts (3035 bytes)
UPDATE src/app/app.component.ts (325 bytes)
✔ Packages installed successfully.
✔ Update package.json
CREATE scully.config.js (65 bytes)
UPDATE package.json (1507 bytes)
```

## @scullyio/init:blog

## Build

Expand All @@ -34,7 +50,7 @@ That's it. You're done! In your project directory, you now have a `/dist/static`
of your app.

__NOTE:__ If you had any errors or warning during the build phase, please follow the instructions in the errors/warnings
(if applicable) or [submit an issue](issues).
(if applicable) or [submit an issue](https://github.com/scullyio/scully/issues/new).

## Test

Expand All @@ -60,4 +76,4 @@ HTML correctly.


---
Next: [Full Documentation ➡️](scully.md)
[Full Documentation ➡️](scully.md)
5 changes: 4 additions & 1 deletion docs/issues.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Scully Issues

Better documentation will be added for creating issues.
Better documentation will be added for creating issues.


[Full Documentation ➡️](scully.md)
5 changes: 4 additions & 1 deletion docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,7 @@ users, it will return a list of userIds.

## <a name="transform-plugins"></a> Data Transform Plugins

Describe data transform plugins
Describe data transform plugins


[Full Documentation ➡️](scully.md)
2 changes: 1 addition & 1 deletion docs/pre-requisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Those 3 topics are very important to successfully start using Scully .



Prev: [Scully ⬅️️](scully.md) | Next: [Getting Started ➡️](getting-started.md)
[Full Documentation ➡️](scully.md)
7 changes: 6 additions & 1 deletion docs/recommended-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,9 @@ _If you would like to add a plugin to this list, please submit a PR to the `docs

## Community Plugins

- (_be the first to submit a plugin_)
- (_be the first to submit a plugin_)




[Full Documentation ➡️](scully.md)
4 changes: 3 additions & 1 deletion docs/scully-configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Scully Configuration

The center of every scully project is the `scully.config.js`. This config file must export the configuration for your
scully build. Whether you need to add a
scully build.

[Full Documentation ➡️](scully.md)
4 changes: 2 additions & 2 deletions schematics/scully/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ You can copy one of the seed project for test more fast.
```
ng add @scullyio/init
ng g @scullyio/init:blog
ng g @scullyio/init:markdown --name
ng g @scullyio/init:post --title
ng g @scullyio/init:post --name="This is my post"
ng g @scullyio/init:markdown --name=my-exmaple --slug=id
npm run scully
```

Expand Down

0 comments on commit 65be7bc

Please sign in to comment.