mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
docs: add missing documentation setup instructions (#48174)
PR Close #48174
This commit is contained in:
parent
7fbb53f52d
commit
2e2135bf18
2 changed files with 21 additions and 2 deletions
|
|
@ -49,6 +49,7 @@ For more information about the required software, see [Setting up the local envi
|
|||
|
||||
Angular requires an [active long-term-support (LTS) or maintenance LTS version](https://nodejs.org/about/releases) of Node.js.
|
||||
|
||||
* [nvm](https://github.com/nvm-sh/nvm#about)
|
||||
* [Yarn](https://yarnpkg.com/getting-started/install)
|
||||
* [Homebrew](https://brew.sh) for macOS or [Chocolatey](https://chocolatey.org/install) for Windows
|
||||
* [Vale][GithubAngularAngularTreeMainAioToolsDocLinterInstallValeOnYourDevelopmentSystemReadmeMd] \(see note\)
|
||||
|
|
@ -277,11 +278,11 @@ After you clone the origin repo on your local computer, run these commands from
|
|||
|
||||
<code-example format="shell" language="shell">
|
||||
|
||||
cd personal/angular/aio
|
||||
cd personal/angular
|
||||
|
||||
</code-example>
|
||||
|
||||
1. Run this command to install the npm modules.
|
||||
1. Run this command to install the Angular dependencies.
|
||||
|
||||
<code-example format="shell" language="shell">
|
||||
|
||||
|
|
@ -289,6 +290,22 @@ After you clone the origin repo on your local computer, run these commands from
|
|||
|
||||
</code-example>
|
||||
|
||||
1. Run this command to navigate to the documentation project.
|
||||
|
||||
<code-example format="shell" language="shell">
|
||||
|
||||
cd aio
|
||||
|
||||
</code-example>
|
||||
|
||||
1. Run this command to install the npm modules for the documentation.
|
||||
|
||||
<code-example format="shell" language="shell">
|
||||
|
||||
yarn setup
|
||||
|
||||
</code-example>
|
||||
|
||||
1. Locate `angular/aio/tools/doc-linter/vale.ini` in your working directory to use in the next step as the path to the configuration file in the **Vale:Config** setting.
|
||||
|
||||
1. [Install Vale][GithubAngularAngularTreeMainAioToolsDocLinterInstallValeOnYourDevelopmentSystemReadmeMd] to complete the software installation.
|
||||
|
|
|
|||
|
|
@ -130,9 +130,11 @@
|
|||
"!/guide/set-document-title/{0,1}",
|
||||
"!/guide/setup-systemjs-anatomy/{0,1}",
|
||||
"!/guide/setup/{0,1}",
|
||||
"!/guide/update-to-latest-version/{0,1}",
|
||||
"!/guide/updating-to-version-10/{0,1}",
|
||||
"!/guide/updating-to-version-11/{0,1}",
|
||||
"!/guide/updating-to-version-12/{0,1}",
|
||||
"!/guide/updating-to-version-13/{0,1}",
|
||||
"!/guide/webpack/{0,1}",
|
||||
"!/guide/{0,1}",
|
||||
"!/news*",
|
||||
|
|
|
|||
Loading…
Reference in a new issue