Skip to content

Commit

Permalink
chore: update website to latest docusaurus (#3948)
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesHenry committed Feb 5, 2024
1 parent 81852dc commit e957589
Show file tree
Hide file tree
Showing 9 changed files with 7,895 additions and 14,629 deletions.
2 changes: 1 addition & 1 deletion website/docs/api-reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Find the available options in [the API docs](/docs/api-reference/commands).

# Nx.json

> NOTE: "{projectRoot}" and "{workspaceRoot}" are special syntax supported by the task-runner, which will be appropriately interpolated internally when the command runs. You should therefore not replace "{projectRoot}" or "{workspaceRoot}" with fixed paths as this makes your configuration less flexible.
> NOTE: "\{projectRoot\}" and "\{workspaceRoot\}" are special syntax supported by the task-runner, which will be appropriately interpolated internally when the command runs. You should therefore not replace "\{projectRoot\}" or "\{workspaceRoot\}" with fixed paths as this makes your configuration less flexible.
```json title="nx.json"
{
Expand Down
4 changes: 2 additions & 2 deletions website/docs/concepts/how-caching-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ instance, we know that changing a `footer`'s spec file will not change the resul

We can define a more precise configuration as follows:

> NOTE: "{projectRoot}" and "{workspaceRoot}" are special syntax supported by the task-runner, which will be appropriately interpolated internally when the command runs. You should therefore not replace "{projectRoot}" or "{workspaceRoot}" with fixed paths as this makes your configuration less flexible.
> NOTE: "\{projectRoot\}" and "\{workspaceRoot\}" are special syntax supported by the task-runner, which will be appropriately interpolated internally when the command runs. You should therefore not replace "\{projectRoot\}" or "\{workspaceRoot\}" with fixed paths as this makes your configuration less flexible.
```json title="nx.json"
{
Expand Down Expand Up @@ -142,7 +142,7 @@ during a cache hit.
Lerna also caches the files generated by a command. The list of files/folders is listed in the `outputs` property of the
project's `package.json`:

> NOTE: "{projectRoot}" and "{workspaceRoot}" are special syntax supported by the task-runner, which will be appropriately interpolated internally when the command runs. You should therefore not replace "{projectRoot}" or "{workspaceRoot}" with fixed paths as this makes your configuration less flexible.
> NOTE: "\{projectRoot\}" and "\{workspaceRoot\}" are special syntax supported by the task-runner, which will be appropriately interpolated internally when the command runs. You should therefore not replace "\{projectRoot\}" or "\{workspaceRoot\}" with fixed paths as this makes your configuration less flexible.
```json title="E.g. packages/my-project/package.json"
{
Expand Down
2 changes: 1 addition & 1 deletion website/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ Nx (the company behind the open source build system of the same name) has taken
- **Computation Caching** - Lerna knows when the task you are about to run has been executed in the past. Instead of running it, Lerna will restore the files and replay the terminal output instantly. Plus, this cache can be shared with your co-workers and CI. When using Lerna, your whole organization will never have to build or test the same thing twice. [Read more »](./features/cache-tasks.md)
- **Configuration-Free Distributed Task Execution** Lerna can distribute any command across multiple machines without any configuration, while preserving the dev ergonomics of running it on a single machine. In other words, scaling your monorepo with Lerna is as simple as enabling a boolean flag. See the examples of how enabling DTE can make you CI 20 times faster. [Read more »](./features/distribute-tasks.md)
- **Beautiful Terminal Output** Monorepos can have hundreds or thousands of projects. Printing everything on every command makes it hard to see what fails and why. Thankfully, Lerna does a much better job.
- **Powerful Graph Visualizer** Lerna comes with a powerful interactive visualizer simplifying the understanding of your workspaces. [Read more »](/docs/getting-started#visualizing-workspace)
- **Powerful Graph Visualizer** Lerna comes with a powerful interactive visualizer simplifying the understanding of your workspaces. [Read more »](/docs/features/project-graph)
- **Publishing to NPM** Lerna is the ultimate tool for publishing multiple packages to npm. Whether the packages have independent versions or not, Lerna has you covered. [Read more »](./features/version-and-publish.md)
- **Easy to Adopt** Even with all these capabilities, Lerna is very easy to adopt. It requires close-to-zero configurations. [Want to see how?](/docs/getting-started)
26 changes: 13 additions & 13 deletions website/docs/lerna-and-nx-version-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ Below is a reference table that matches versions of Lerna to the version of Nx t

We provide a recommended version, and it is usually the latest minor version of Nx in the range provided because there will have been bug fixes added since the first release in the range.

| Lerna Version | **Nx Version _(recommended)_** | Nx Version _(range)_ |
| ----------------- | ------------------------------ | -------------------- |
| >=8.0.0 <= latest | **latest** | >=17.1.2 <= latest |
| >=7.1.4 <= latest | 16.10.0 | >=16.5.1 < 17 |
| >= 7.0.0 < 7.1.4 | 16.10.0 | >=16.3.1 < 17 |
| >= 6.5.0 < 7.0.0 | 15.9.4 | >=15.5.2 < 16 |
| >= 6.4.0 < 6.5.0 | 15.9.4 | >=15.4.2 < 16 |
| >= 6.0.1 < 6.4.0 | 15.9.4 | >=14.8.6 < 16 |
| >= 5.6.0 < 6.0.1 | 15.9.4 | >=14.8.1 < 16 |
| >=5.5.0 < 5.6.0 | 15.9.4 | >=14.6.1 < 16 |
| >=5.4.0 < 5.5.0 | 15.9.4 | >=14.5.4 < 16 |
| >= 5.2.0 < 5.4.0 | 15.9.4 | >=14.4.3 < 16 |
| < 5.2.0 | N/A\* | N/A\* |
| Lerna Version | **Nx Version _(recommended)_** | Nx Version _(range)_ |
| ------------------- | ------------------------------ | -------------------- |
| `>=8.0.0 <= latest` | **latest** | `>=17.1.2 <= latest` |
| `>=7.1.4 < 8.0.0` | `16.10.0` | `>=16.5.1 < 17` |
| `>= 7.0.0 < 7.1.4` | `16.10.0` | `>=16.3.1 < 17` |
| `>= 6.5.0 < 7.0.0` | `15.9.4` | `>=15.5.2 < 16` |
| `>= 6.4.0 < 6.5.0` | `15.9.4` | `>=15.4.2 < 16` |
| `>= 6.0.1 < 6.4.0` | `15.9.4` | `>=14.8.6 < 16` |
| `>= 5.6.0 < 6.0.1` | `15.9.4` | `>=14.8.1 < 16` |
| `>=5.5.0 < 5.6.0` | `15.9.4` | `>=14.6.1 < 16` |
| `>=5.4.0 < 5.5.0` | `15.9.4` | `>=14.5.4 < 16` |
| `>= 5.2.0 < 5.4.0` | `15.9.4` | `>=14.4.3 < 16` |
| `< 5.2.0` | N/A\* | N/A\* |

\*Lerna does not depend on Nx before version 5.2.0
2 changes: 1 addition & 1 deletion website/docs/lerna-and-nx.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Lerna defers to Nx's power task runner behind the scenes to detect task dependen

### Features

1. [Share cached task results across the organization](./features/cache-tasks#distributed-computation-caching)
1. [Share cached task results across the organization](./features/cache-tasks)
2. [Distribute task execution](./features/distribute-tasks) efficiently across agent machines

### Cost
Expand Down
4 changes: 2 additions & 2 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const lightCodeTheme = require("prism-react-renderer").themes.github;
const darkCodeTheme = require("prism-react-renderer").themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
Expand Down
Loading

0 comments on commit e957589

Please sign in to comment.