mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-04 12:47:14 +02:00
* Correct npm run tsc to npm run typecheck According to this page, you should run `npm run tsc` to run `tsc` and do a type check. However, in the package.json file for Docusaurus version 2.0.0-beta.17 the command is actually `npm run typecheck`, which runs `tsc`. This update only replaces `tsc` with `typecheck` so the npm script will run correctly. * Recommend npx tsc for type-checking Based on feedback for the original change to replace `npm run tsc` with `npm run typecheck`, a better solution that was suggested was to use npx to run tsc instead of an npm script. `npx tsc` should work regardless of the template/presets you installed when you installed Docusaurus. |
||
---|---|---|
.. | ||
_dogfooding | ||
blog | ||
community | ||
docs | ||
src | ||
static | ||
versioned_docs | ||
versioned_sidebars | ||
babel.config.js | ||
delayCrowdin.mjs | ||
docusaurus.config-blog-only.js | ||
docusaurus.config.js | ||
netlify.toml | ||
package.json | ||
README.md | ||
sidebars.js | ||
sidebarsCommunity.js | ||
testCSSOrder.mjs | ||
tsconfig.json | ||
versions.json | ||
versionsArchived.json | ||
waitForCrowdin.mjs |
Docusaurus 2 Website
Installation
yarn install
in the root of the repo (one level above this directory).- In this directory, do
yarn start
. - A browser window will open up, pointing to the docs.