b51676a89a
Updates the docs structure, navigation etc to be easier + better suited for showing Nx technology support beyond just TS. **Notes:** - API (`/nx-api`) tab is removed from the navigation (i.e. menu bar), but pages still remain for now until we update references in `*.md` files. - Redirects are set up `/nx-api` to go to their respect new location e.g. `/technologies` or `/reference/core-api` - Old URLs still exist in the sitemap for now, but majority of them will be redirected -- a follow-up PR can remove them. **Preview:** https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs --------- Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
21 lines
967 B
Markdown
21 lines
967 B
Markdown
# Function: readProjectConfiguration
|
|
|
|
▸ **readProjectConfiguration**(`tree`, `projectName`): [`ProjectConfiguration`](/reference/core-api/devkit/documents/ProjectConfiguration)
|
|
|
|
Reads a project configuration.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------------ | :-------------------------------------------------- | :---------------------------------------------------------------------- |
|
|
| `tree` | [`Tree`](/reference/core-api/devkit/documents/Tree) | the file system tree |
|
|
| `projectName` | `string` | unique name. Often directories are part of the name (e.g., mydir-mylib) |
|
|
|
|
#### Returns
|
|
|
|
[`ProjectConfiguration`](/reference/core-api/devkit/documents/ProjectConfiguration)
|
|
|
|
**`Throws`**
|
|
|
|
If supplied projectName cannot be found
|