15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-28 20:52:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
docusaurus/website
History
Jadon N 19d2a18817
docs: npm run tsc -> npx tsc (#6978) 
* 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.
 		2022-03-24 11:14:09 +08:00
..
_dogfooding refactor(theme-{classic,common}): change how site/page/search metadata is handled (#6925) 2022-03-18 18:53:00 +01:00
blog docs: fix broken links (#6817) 2022-03-03 07:02:57 +08:00
community feat(website): new plugin to load CHANGELOG and render as blog (#6414) 2022-01-27 23:17:31 +08:00
docs docs: npm run tsc -> npx tsc (#6978) 2022-03-24 11:14:09 +08:00
src test: improve test coverage; reorder theme-common files (#6956) 2022-03-22 15:33:55 +08:00
static refactor: self-host KaTeX assets (#6429) 2022-01-27 11:39:45 +01:00
versioned_docs chore: upgrade dependencies (#6916) 2022-03-15 13:16:21 +08:00
versioned_sidebars chore: prepare v2.0.0-beta.17 release (#6829) 2022-03-03 18:44:41 +01:00
README.md feat(v2): disable optimization.removeAvailableModules for webpack performance (#1711) 2019-07-26 22:42:03 +07:00
babel.config.js chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
delayCrowdin.mjs chore: clean up ESLint config, enable a few rules (#6514) 2022-01-31 10:31:24 +08:00
docusaurus.config-blog-only.js chore: upgrade docsearch-react to v3 stable, bump dependencies (#6752) 2022-02-24 19:39:32 +08:00
docusaurus.config.js chore: migrate Jest and website to SWC (#6944) 2022-03-19 20:56:30 +08:00
netlify.toml chore: upgrade netlify-cli (#6031) 2021-11-30 10:02:31 +08:00
package.json chore: upgrade dependencies (#6946) 2022-03-21 07:45:29 +08:00
sidebars.js feat(core): rework swizzle CLI (#6243) 2022-02-25 14:13:15 +01:00
sidebarsCommunity.js feat(website): new plugin to load CHANGELOG and render as blog (#6414) 2022-01-27 23:17:31 +08:00
testCSSOrder.mjs feat(core): rework swizzle CLI (#6243) 2022-02-25 14:13:15 +01:00
tsconfig.json chore(website): enable strict compiler option (#6012) 2021-11-26 18:14:35 +08:00
versions.json chore: prepare v2.0.0-beta.17 release (#6829) 2022-03-03 18:44:41 +01:00
versionsArchived.json chore: prepare v2.0.0-beta.17 release (#6829) 2022-03-03 18:44:41 +01:00
waitForCrowdin.mjs chore: clean up ESLint config, enable a few rules (#6514) 2022-01-31 10:31:24 +08:00

README.md

Docusaurus 2 Website

Installation

  1. yarn install in the root of the repo (one level above this directory).
  2. In this directory, do yarn start.
  3. A browser window will open up, pointing to the docs.