pan93412 dfb6986b93

docs(core): extend the description of generator schema options (#7927) ...

* docs(core): describe every properties available in schema.json

The current Generator documentation is not completed. Thus,
I managed to describe every undocumented part of generator currently.

This document is referenced from a lot of current `schema.json`
and code of it. Thanks a lot! :D

- Overview
- Description
- Examples

* docs(misc): add the instruction when out of memory

Added a new section: "When occurred `JavaScript heap out of memory`"

Also fixed some lint issues indicated by `markdownlint`.

* fix(misc): grammars

Co-authored-by: isaacplmann <isaacplmann@users.noreply.github.com>

* docs(core): more complete Generator

- correct grammars errors
- complete most the WIP part
- remove `items` since I didn't find any example of it

Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
Co-Authored-By: Jonathan Cammisuli <Cammisuli@users.noreply.github.com>

* docs(core): correct the format

Co-authored-by: isaacplmann <isaacplmann@users.noreply.github.com>
Co-authored-by: Jonathan Cammisuli <Cammisuli@users.noreply.github.com>

2021-12-14 10:33:51 -05:00

..

api

docs(nx): generate different flavours of nx docs

2019-08-17 13:25:22 -04:00

cli

docs(nxdev): better api generator templates (#8109)

2021-12-10 12:18:46 -05:00

examples

docs(docs): add examples section (#3165)

2020-06-12 22:09:48 -04:00

generators

docs(core): extend the description of generator schema options (#7927)

2021-12-14 10:33:51 -05:00

guides

docs(core): adjust header ordering in the Nx and Turborepo guide

2021-12-14 15:53:54 +01:00

mental-model

docs(nxdev): home updates (#7567)

2021-11-12 11:59:45 -05:00

migration

docs(core): fix docs changes for config page

2021-12-09 15:54:40 -05:00

workspace

docs(nxdev): fix typo in project-graph-plugin guide (#6655)

2021-08-09 08:02:41 -05:00

affected.md

feat(core): shift from 'master' to 'main' as default branch and base (#7111)

2021-10-08 16:48:02 -04:00

affected.png

docs(core): update guide and images for affected deep dive (#6757)

2021-08-18 07:35:20 -05:00

all-cache-inputs.png

docs(core): add guides on caching and incremental builds

2020-03-26 17:03:50 -04:00

angular-logo.png

docs(angular): refresh angular plugin overview docs (#6192)

2021-06-30 19:18:28 +01:00

angular-plugin.md

feat(angular): init mfe generator (#6209)

2021-07-02 13:45:36 +01:00

caching-example.png

docs(core): add guides on caching and incremental builds

2020-03-26 17:03:50 -04:00

ci-graph-everything-affected.png

docs(core): add ci guides for Jenkins and Azure

2020-02-16 10:08:51 -05:00

ci-graph-one-affected.png

docs(core): add ci guides for Jenkins and Azure

2020-02-16 10:08:51 -05:00

ci-graph.png

docs(core): add ci guides for Jenkins and Azure

2020-02-16 10:08:51 -05:00

ci-overview.md

docs(core): reorganize CI guides (#7453)

2021-10-20 11:51:18 -04:00

computation-caching.md

feat(web): rename @nrwl/web:build to @nrwl/web:webpack (#7952)

2021-11-30 14:22:34 -05:00

console.md

docs(angular): fix minor issues with Nx Console docs and icon loading (#6295)

2021-07-09 12:46:50 -05:00

continue-light.svg

Console documentation (#3086)

2020-05-29 09:40:23 -04:00

cypress-logo.png

feat(docs): scope docs

2019-06-19 17:13:32 -04:00

cypress-plugin.md

docs(testing): document adding Cypress E2E app for an existing project (#7669)

2021-11-09 11:15:34 -06:00

daemon.md

docs(core): fix daemon process enablement option

2021-11-23 13:32:05 -05:00

dependency-graph.png

docs(core): update guide and images for affected deep dive (#6757)

2021-08-18 07:35:20 -05:00

devkit-and-nx-plugins.md

docs(react): rework the core section to highlight nx core

2021-10-28 19:48:13 -04:00

distributed-builds.md

docs(misc): ci guides minor fixes

2021-10-20 20:54:56 -04:00

eslint.md

docs(misc): fixing formatting on eslint guide (#6216)

2021-07-01 09:07:03 -07:00

express-plugin.md

docs(core): documentation format fix (#6058)

2021-06-17 13:55:49 -04:00

folder-light.svg

Console documentation (#3086)

2020-05-29 09:40:23 -04:00

gatsby-plugin.md

docs(core): documentation format fix (#6058)

2021-06-17 13:55:49 -04:00

github.png

docs(misc): add docs on adding nx to monorepo

2021-02-01 13:35:44 -05:00

incremental-build-webpack-vs-incremental.png

docs(core): incremental builds with Angular and React (#4366)

2020-12-21 10:39:46 -05:00

incremental-builds.md

docs(misc): fix a typo

2021-10-15 10:52:56 -04:00

jest-logo.png

feat(docs): scope docs

2019-06-19 17:13:32 -04:00

jest-plugin.md

docs(misc): update consistency for root files, generators, and executors

2021-05-27 13:29:04 -04:00

mental-model.md

docs(nxdev): home updates (#7567)

2021-11-12 11:59:45 -05:00

monorepo-ci-azure.md

docs(misc): Update azure devops condition script (#7637)

2021-11-09 11:21:30 -06:00

monorepo-ci-circle-ci.md

docs(react): rework the core section to highlight nx core

2021-10-28 19:48:13 -04:00

monorepo-ci-github-actions.md

docs(misc): ci guides minor fixes

2021-10-20 20:54:56 -04:00

monorepo-ci-gitlab.md

docs(core): add gitlab ci guide (#7878)

2021-12-02 09:52:30 -06:00

monorepo-ci-jenkins.md

docs(misc): ci guides minor fixes

2021-10-20 20:54:56 -04:00

monorepo-nx-enterprise.md

feat(core): shift from 'master' to 'main' as default branch and base (#7111)

2021-10-08 16:48:02 -04:00

monorepo-tags.md

docs(linter): fix wrong rule format in tags guide (#8101)

2021-12-10 13:35:54 +01:00

nest-logo.png

docs(nx): share guides between different nx.dev flavours

2019-07-31 15:48:09 -04:00

nest-plugin.md

docs(core): documentation format fix (#6058)

2021-06-17 13:55:49 -04:00

next-plugin.md

docs(nextjs): update overview and guide (#6462)

2021-07-22 10:41:32 -04:00

nextjs-logo.png

docs(nextjs): update overview and guide (#6462)

2021-07-22 10:41:32 -04:00

node-plugin.md

docs(core): documentation format fix (#6058)

2021-06-17 13:55:49 -04:00

nx-console-logo.png

docs(docs): move nx console page under cli (#2881)

2020-04-21 11:54:19 -04:00

nx-console-screenshot.png

docs(docs): move nx console page under cli (#2881)

2020-04-21 11:54:19 -04:00

nx-core.md

feat(core): deprecate --max-parallel and use --paralle=N instead

2021-11-09 20:03:24 -05:00

nx-plugin.md

cleanup(misc): rename collection.json to generators.json (#6442)

2021-07-21 11:42:43 +01:00

prettier-logo.png

docs(nx): share guides between different nx.dev flavours

2019-07-31 15:48:09 -04:00

react-plugin.md

fix(react): Fix typo (#7748)

2021-11-16 18:00:23 -05:00

refresh-light.svg

Console documentation (#3086)

2020-05-29 09:40:23 -04:00

running-custom-commands.md

docs(core): documentation format fix (#6058)

2021-06-17 13:55:49 -04:00

storybook-logo.png

docs(nx): add storybook guides for react and angular (#2078)

2019-11-27 11:10:48 -05:00

tools-workspace-builders.md

docs(misc): fix executor example

2021-09-15 12:06:03 -04:00

update.md

docs(core): update nx migrate guide (#6155)

2021-06-28 09:37:46 -05:00

using-executors.md

feat(web): rename @nrwl/web:build to @nrwl/web:webpack (#7952)

2021-11-30 14:22:34 -05:00

vscode-schematics-debug.png

docs(core): add section on debugging workspace schematics with VSCode

2020-03-08 18:06:14 -04:00

web-plugin.md

docs(core): documentation format fix (#6058)

2021-06-17 13:55:49 -04:00

workspace-plugin.md

docs(nxdev): flatten the docs

2021-02-05 20:33:28 -05:00