Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/blog.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Scully w/ Blogs
# Scully with Blogs

Scully is your best friend when you want to move your blog to Angular!

Expand Down Expand Up @@ -31,7 +31,7 @@ or
ng g @scullyio/init:markdown --name="my text" --slug="my slug id"
```

the following table shows all vailable options:
the following table shows all available options:

| option | description | default |
| -------------- | ------------------------------------------------------------------------------ | ------------------------ |
Expand All @@ -45,13 +45,13 @@ the following table shows all vailable options:

## Generating New Blog Posts

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

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

the following table shows all vailable options:
the following table shows all available options:

| option | description | default |
| -------------- | ------------------------------------------------------ | --------- |
Expand Down
14 changes: 7 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ UPDATE package.json (1507 bytes)

#### IMPORTANT: _Scully requires the router to be present in your application, don't forget to add it._

#### IMPORTANT: _Scully requires the distrubution files to be in a subfolder of `./dist`_
#### IMPORTANT: _Scully requires the distribution files to be in a subfolder of `./dist`_

If you have an angular app, that outputs the distribution files directly into to root of `./dist` Scully can't copy all of the dist files. This is an OS file-system issue. We can't copy recursively into a subfolder of dist. The solution is set the option `architect->build->options->outputPath` to a subfolder.
If you have an angular app, that outputs the distribution files directly into the root of `./dist` Scully can't copy all of the dist files. This is an OS file-system issue. We can't copy recursively into a subfolder of dist. The solution is to set the option `architect->build->options->outputPath` to a subfolder.

## ng g @scullyio/init:blog

Expand All @@ -69,17 +69,17 @@ Once it's generated you can open the default `app.component.html` created by ang

### Home page

Since the default template from angular-cli doesn't ship an entry point for route, it might be confusing to get scully working on the very first shot
Since the default template from angular-cli doesn't ship an entry point for route, it might be confusing to get Scully working on the very first shot.

```ts
ng g m home --route=home --module=app-routing
```

This command will generate the new home page module plus a new component with a route configured
This command will generate the new home page module plus a new component with a route configured.

### Configure home as root

Open `app-routing.module.ts` and let the path attribute empty for the home route
Open `app-routing.module.ts` and let the path attribute empty for the home route.

```ts
const routes: Routes = [
Expand All @@ -93,7 +93,7 @@ const routes: Routes = [

### Inject route service

Scully provides a service to easy get access on generated routes. To list these in your template open `home.component.ts` by adding the following code
Scully provides a service to easy get access on generated routes. To list these in your template open `home.component.ts` by adding the following code:

```ts
import {ScullyRoutesService} from '@scullyio/ng-lib';
Expand Down Expand Up @@ -153,7 +153,7 @@ Now that your project has been pre-rendered, you can validate the build by eithe

By utilizing something like [http-server](https://www.npmjs.com/package/http-server) you can serve the contents of your
`dist/static` folder. All of the routes in your non-pre-rendered Angular app should still work. Not all apps are
capable of running without
capable of running without.

[//]: # 'Missing text for the line above'

Expand Down
16 changes: 8 additions & 8 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The `registerPlugin` is the method created to add new plugins to scully. This me

### type: PluginTypes

`type` is a reference the to the type of plugin. It could be `render`, `router` or `fileHandler`.
`type` is a reference to the type of plugin. It could be `render`, `router` or `fileHandler`.

### name: string

Expand All @@ -44,7 +44,7 @@ The `registerPlugin` is the method created to add new plugins to scully. This me
```typescript
import {yellow} from '@scullyio/scully/utils/log';

// Omited code ...
// Omitted code ...

const validator = async options => {
const errors = [];
Expand Down Expand Up @@ -86,7 +86,7 @@ had 5 users with the IDs 1, 2, 3, 4, and 5, then Scully would need to render the
/user/5
```

A **router plugin** is used to convert the raw route config into a list of routes that scully can then crawl/render.
A **router plugin** is used to convert the raw route config into a list of routes that Scully can then crawl/render.

## `HandledRoute` interface

Expand All @@ -100,11 +100,11 @@ export interface HandledRoute {
}
```

The `HandledRoute` interface provide you properties to develop your own pluging.
The `HandledRoute` interface provides you properties to develop your own plugin.

### route: string

`route` is a reference to the route to handled in you project.
`route` is a reference to the route to handle in your project.

### type: RoutesTypes

Expand All @@ -114,13 +114,13 @@ It should be to the type of the existing Route plugin.

### postRenderers?: string[]

`postRenderers` is a reference to plugins you want to be execute after scully's render process.
`postRenderers` is a reference to plugins you want to be executed after Scully's render process.

### templateFile?: string

`templateFile` is a reference to name of the template to render the content.
`templateFile` is a reference to the name of the template to render the content.

_\*\*\_Important_\*\*, It's not a reference to the angular template.\_
**Important**, It's not a reference to the angular template.\_

### data?: RouteData

Expand Down
2 changes: 1 addition & 1 deletion docs/pre-requisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Before you start building awesome sites with **Scully**, you will need to unders
- GIT
- Node.js

Those 3 topics are very important to successfully start using Scully .
Those 3 topics are very important to successfully start using Scully.

### Software tools needed to work with Scully are:

Expand Down
2 changes: 1 addition & 1 deletion docs/scully-cmd-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Scully CLI has the following options available:
npx scully serve
```

this starts the scully server helper on its own. You can use this to inspect the result from Scully, or to speed up the scully proccess a bit. it does not _build_ the project, it only serves the angular build files, and the scully result files.
This starts the scully server helper on its own. You can use this to inspect the result from Scully, or to speed up the scully proccess a bit. it does not _build_ the project, it only serves the angular build files, and the scully result files.

## showBrowser

Expand Down
30 changes: 15 additions & 15 deletions docs/scully-configuration.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Scully Configuration

The center of every scully project is the file `scully.config.js`. This config file must export the configuration for your
The center of every Scully project is the file `scully.config.js`. This config file must export the configuration for your
scully build.

If you are starting to use scully we highly recommend read the [Getting Started](getting-started.md) section,
also if you want to enhance you project made with scully, visit the [Utils](utils.md) section and see
or teach to the community how to combine scully with others tools.
If you are starting to use Scully we highly recommend read the [Getting Started](getting-started.md) section,
also if you want to enhance your project made with Scully, visit the [Utils](utils.md) section and see
or teach to the community how to combine Scully with others tools.

- [Scully Configuration](#scully-configuration)
- [`ScullyConfig` Interface](#scullyconfig-interface)
Expand Down Expand Up @@ -46,15 +46,15 @@ export interface ScullyConfig {
}
```

`ScullyConfig` interface provide the parameters to configure how scully works in your project.
`ScullyConfig` interface provide the parameters to configure how Scully works in your project.

## scullyConfig properties explained

### projectRoot

`projectRoot` is reference to the path to the project where scully will intervene.
`projectRoot` is reference to the path to the project where Scully will intervene.

This property is **_mandatory_**, scully fill automatically post installation,
This property is **_mandatory_**, Scully fills automatically post installation,

**_IMPORTANT_** this property won't be **_mandatory_** anymore in future releases.

Expand All @@ -65,7 +65,7 @@ This property is for internal use mostly, it defaults to the location where angu

### outDir

`outDir` is reference to the path folder which scully will take to put the statics files.
`outDir` is reference to the path folder which Scully will take to put the statics files.
By default the path is:

```
Expand All @@ -74,7 +74,7 @@ By default the path is:

### distFolder

`distFolder` option provide to scully the path to the compiled Angular application. By default scully take the path
`distFolder` option provide to Scully the path to the compiled Angular application. By default Scully take the path
reading the `angular.json`. You can set it up follow your needs.

### routes
Expand Down Expand Up @@ -102,9 +102,9 @@ handled routes reference to routes with dynamic data.

## proxyConfig

Takes a relative filename filename for a proxy config file. for details look at [this](https://github.com/chimurai/http-proxy-middleware/blob/master/README.md). We use the same config format as [webpackDevServer](https://webpack.js.org/configuration/dev-server/#devserverproxy)
Takes a relative filename filename for a proxy config file. For details look at [this](https://github.com/chimurai/http-proxy-middleware/blob/master/README.md). We use the same config format as [webpackDevServer](https://webpack.js.org/configuration/dev-server/#devserverproxy).

`routes` is a reference to all unhandled routes which scully will transform to handled, using plugins.
`routes` is a reference to all unhandled routes which Scully will transform to handled, using plugins.
If you want to know more about plugins go to [Plugins](plugins.md) section.

### extraRoutes
Expand All @@ -120,14 +120,14 @@ extraRoutes: ['/foo/id', new Promise('/bar/barId'), new Promise(['/foo/fooId', '

### appPort

Scully provide you a server to check how your Angular app works.
Scully provides you a server to check how your Angular app works.
`appPort` is the property to configure the port which your Angular app will run.

The port by default is: `1864`

### staticport

Similarly as _appPort_, the property `staticport` allow the developer set up a port to execute a server,
Similarly as _appPort_, the property `staticport` allows the developer to set up a port to execute a server,
which will serve static files compiled by Scully.

The port by default is: `1668`
Expand All @@ -145,11 +145,11 @@ Follow [this link](https://pptr.dev/#?product=Puppeteer&version=v2.0.0&show=api-

### hostName

use a different name as `localhost` for the local server. Needed if doe to environmental restrictions localhost isn't usable
Use a different name as `localhost` for the local server. Needed if doe to environmental restrictions localhost isn't usable

### hostUrl

Connect to a other server. If your app has special demands to host it, you might need to use your own server. When that is needed you can provide this setting to let scully know where to look for your running app. Make sure the server is up and running, and hosting the correct application.
Connect to another server. If your app has special demands to host it, you might need to use your own server. When that is needed you can provide this setting to let Scully knows where to look for your running app. Make sure the server is up and running, and hosting the correct application.

### guessParserOptions

Expand Down
12 changes: 6 additions & 6 deletions docs/scully-lib-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Idle Monitor

Scully implements the `IdleMonitorService` to hook into Zonejs. When angular goes idle (**more precise, when all outgoing HTTP-requests are settled**)
Scully trigger Puppeteer, and knows when it's ready to render.
Scully implements the `IdleMonitorService` to hook into Zonejs. When Angular goes idle (**more precise, when all outgoing HTTP-requests are settled**)
Scully triggers Puppeteer, and knows when it's ready to render.

Without this process, we have to resort to a (25 seconds) timeout. this is both slower and unprecise, some pages need even more time.

Expand All @@ -20,7 +20,7 @@ the routes rendered by Scully.
- getCurrent()
- reload()

The `ScullyRoutesService` use the `ScullyRoute` interface to set types.
The `ScullyRoutesService` uses the `ScullyRoute` interface to set types.

```typescript
export interface ScullyRoute {
Expand All @@ -47,15 +47,15 @@ export interface ScullyRoute {

#### getCurrent(): _Observable<ScullyRoute>_

`getCurrent()` method returns the current location
`getCurrent()` method returns the current location.

#### reload(): _void_

`reload` method checks if new routes was added in the `scully-routes.json`.
`reload` method checks if new routes were added in the `scully-routes.json`.

## Scully Content

Scully use the `scully-content` to insert the result of the render process into the HTML document.
Scully uses the `scully-content` to insert the result of the render process into the HTML document.

The `scully-content` component won't work inside a `*ngIf` directive.

Expand Down
6 changes: 3 additions & 3 deletions docs/utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ Check out also the official [docs of prismjs](https://prismjs.com/)

### Do you want to colaborate with scully?

We would really love knows how are you combining scully with other tools.
If you want to share your experiencie with the community please check our [CONTRIBUTING](../CONTRIBUTING.md) file,
and don't forget sign the [CLA](https://cla-assistant.io/scullyio/scully).
We would really love to know how you are combining Scully with other tools.
If you want to share your experience with the community please check our [CONTRIBUTING](../CONTRIBUTING.md) file,
and don't forget to sign the [CLA](https://cla-assistant.io/scullyio/scully).

---

Expand Down