Skip to content

Commit

Permalink
Docs/beta (#442)
Browse files Browse the repository at this point in the history
* docs(schematics): mARKDOWN: update docs for markdown and blog

* docs(scully): gettingStarted: update getting started with the last options and text from scully

* docs(docsWeb): add favicon

* docs(docsWeb): fix TOOLS & RESOURCES links and text

* docs(docsWeb): fix and review getting-started

* feat(scully): add highlight.js for md files

* docs(docsWeb): change styling

* docs(docsWeb): add highlight flag into docs and fix nowatch flag

* docs(docsWeb): fix links from core

* change some typos
  • Loading branch information
jorgeucano authored Apr 7, 2020
1 parent 1619215 commit 935b4ee
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/scully-cmd-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Starts the scully server. This process does not _build_ the project. It only ser
npx scully --watch
```

By default, Scully has the watchMode in false. You need add this flag for use Watch Mode.
By default, Scully has the watchMode in false. You need to add this flag to use Watch Mode.

## showBrowser

Expand Down Expand Up @@ -140,9 +140,9 @@ Adds a url to an ssl key file for a server with SSL.
npx scully serve/watch --hl
```

Add highlight.js render into the markdown's files.
Add highlight.js to render into the markdown's files.

If you use this flag, you need add the css into the index.html:
If you use this flag, you need to add the css into the index.html:

```html
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/styles/default.min.css" />
Expand Down
6 changes: 3 additions & 3 deletions docs/scully-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,17 @@ export interface ScullyConfig {
projectRoot?: string;
/** the folder where the project sources resides, read from angular.json */
sourceRoot?: string;
/** Array with string ID's of the content-renderes that will be run on all routes */
/** Array with string ID's of the content-renders that will be run on all routes */
defaultPostRenderers: string[];
/** the root of the project (where angular.json lives) */
homeFolder: string;
/** the destination off the Scully generated files */
/** the destination of the Scully generated files */
outDir?: string;
/** the place where distribution files of the project are. Should be a subfolder of dist. */
distFolder?: string;
/** transferState only inlined into page, and not written into separate data.json */
inlineStateOnly: boolean;
/** routes that needs additional processing have their configuration in here */
/** routes that need additional processing have their configuration in here */
routes: RouteConfig;
/** routes that are in the application but have no route in the router */
extraRoutes?: (string | Promise<string[] | string>)[];
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"scully:compile:watch": "tsc -w -p ./scully/tsconfig.scully.json",
"scully:compile:run": "npm run scully:compile && npm run scully:run",
"scully:run": "node ./dist/scully/scully --tds --project=sampleBlog",
"scully:run:docs": "node ./dist/scully/scully --tds --project=scullyDocs",
"scully:run:docs": "node ./dist/scully/scully --tds --project=scullyDocs --hl=true ",
"scully:run:tests": "npm run test && npm run e2e:server",
"scully:run:cypress": "node ./dist/scully/scully serve --project=sampleBlog --tds",
"scully:serve": "node ./dist/scully/scully serve --tds --project=sampleBlog",
Expand All @@ -27,7 +27,7 @@
"plugin:flash:publish": "npm run plugin:flash:build -- --deploy=true",
"docs:playground": "angular-playground",
"docs:run": "ng serve --project=docsSite",
"docs:build": "ng build scullyDocs --prod && npm run scully:run:docs",
"docs:build": "ng build --prod && npm run scully:run:docs",
"changelog": "npx conventional-changelog -p scully -i ./CHANGELOG.md -s && git add ./CHANGELOG.md",
"commit": "git add . && npx git-cz",
"commit:select": "npx git-cz"
Expand Down

0 comments on commit 935b4ee

Please sign in to comment.