Skip to content

docs(scully): add docs for prod cli option #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SanderElias merged 2 commits into from
Jul 9, 2020
Merged

docs(scully): add docs for prod cli option #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0939a62
docs(scully): add docs for prod cli option
jorgeucano Jul 9, 2020
d8bff69
fix(monorepo): update snapshots
SanderElias Jul 9, 2020
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
9 changes: 9 additions & 0 deletions docs/scully-cmd-line.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ The Scully CLI has the following available options:
- [pluginsError](#pluginserror)
- [pjFirst](#pjfirst)
- [404](#404)
- [prod](#prod)

## Serve

Expand Down Expand Up @@ -197,3 +198,11 @@ npx scully --040="none"

How routes that are not provided in the application are handled.
If the Scully server gets a request for a route(file) that does not exists on the file-system, this option amends ow that is handled. The default option is to render a 404 page, and raise a warning during rendering. the `index` and `404` will render the `index.html` or the `404.html` from the dist root folder. The `none` option will leave it up to the express software layer. And lastly, `baseOnly` will use the unhandled routes only

## prod

```bash
npx scully --prod
```

With the prod flag you can use a different config for your scully config and plugins. [example](https://github.com/scullyio/scully/blob/main/scully.scully-docs.config.ts#L15)
4 changes: 4 additions & 0 deletions tests/jest/src/__tests__/__snapshots__/docsThere.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2204,6 +2204,7 @@ exports[`docsSite should have content for all markdown files check html for mark
<li =\\"\\"><a href=\\"/docs/scully-cmd-line#pluginserror\\" =\\"\\">pluginsError</a></li>
<li =\\"\\"><a href=\\"/docs/scully-cmd-line#pjfirst\\" =\\"\\">pjFirst</a></li>
<li =\\"\\"><a href=\\"/docs/scully-cmd-line#404\\" =\\"\\">404</a></li>
<li =\\"\\"><a href=\\"/docs/scully-cmd-line#prod\\" =\\"\\">prod</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -2280,6 +2281,9 @@ npx scully --040=<span class=\\"hljs-string\\" =\\"\\">\\"404\\"</span>
npx scully --040=<span class=\\"hljs-string\\" =\\"\\">\\"none\\"</span></code></pre>
<p =\\"\\">How routes that are not provided in the application are handled.
If the Scully server gets a request for a route(file) that does not exists on the file-system, this option amends ow that is handled. The default option is to render a 404 page, and raise a warning during rendering. the <code =\\"\\">index</code> and <code =\\"\\">404</code> will render the <code =\\"\\">index.html</code> or the <code =\\"\\">404.html</code> from the dist root folder. The <code =\\"\\">none</code> option will leave it up to the express software layer. And lastly, <code =\\"\\">baseOnly</code> will use the unhandled routes only</p>
<h2 id=\\"prod\\" =\\"\\">prod</h2>
<pre =\\"\\"><code class=\\"language-bash\\" =\\"\\">npx scully --prod</code></pre>
<p =\\"\\">With the prod flag you can use a different config for your scully config and plugins. <a href=\\"https://github.com/scullyio/scully/blob/main/scully.scully-docs.config.ts#L15\\" =\\"\\">example</a></p>
<!--scullyContent-end--><script>try {window['scullyContent'] = {cssId:\\"\\",html:document.body.innerHTML.split('<!--scullyContent-begin-->')[1].split('<!--scullyContent-end-->')[0]};} catch(e) {console.error('scully could not parse content');}</script><scully-content =\\"\\"></scully-content></app-doc-page><!----></main><div =\\"\\"></div></app-docs><!----></main><footer =\\"\\"><div =\\"\\" class=\\"footer-1\\"><h3 =\\"\\">Learn</h3><p =\\"\\"><a =\\"\\" routerlink=\\"/docs/Introduction\\" href=\\"/docs/Introduction\\">Docs</a></p><p =\\"\\"><a =\\"\\" routerlink=\\"/docs/getting-started\\" href=\\"/docs/getting-started\\">Quickstart</a></p></div><div =\\"\\" class=\\"footer-2\\"><h3 =\\"\\">Community</h3><p =\\"\\"><a =\\"\\" routerlink=\\"/docs/CONTRIBUTING\\" href=\\"/docs/CONTRIBUTING\\">Contribute</a></p><p =\\"\\"><a =\\"\\" target=\\"_blank\\" href=\\"https://gitter.im/scullyio/community\\">Gitter Channel</a></p><p =\\"\\"><a =\\"\\" target=\\"_blank\\" href=\\"https://twitter.com/scullyio\\">Twitter</a></p></div><div =\\"\\" class=\\"footer-3\\"><h3 =\\"\\">Organization</h3><p =\\"\\"><a =\\"\\" target=\\"_blank\\" href=\\"https://herodevs.com/\\">About Us</a></p><p =\\"\\"><a =\\"\\" href=\\"mailto:aaron@hero.dev\\">Contact Us</a></p><p =\\"\\"><a =\\"\\" target=\\"_blank\\" href=\\"https://github.com/scullyio/scully/tree/main/assets/logos\\">Press Kit</a></p></div></footer></app-root>
<script id=\\"ScullyIO-transfer-state\\"></script>

Expand Down