create-docusaurus 0.0.0-4330 → 0.0.0-4334

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/package.json +3 -3
  2. package/templates/classic/package.json +3 -3
  3. package/templates/classic-typescript/package.json +4 -4
  4. package/templates/facebook/package.json +3 -3
  5. package/templates/shared/docs/intro.md +19 -7
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-docusaurus",
3
- "version": "0.0.0-4330",
3
+ "version": "0.0.0-4334",
4
4
  "description": "Create Docusaurus apps easily.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,7 +23,7 @@
23
23
  },
24
24
  "license": "MIT",
25
25
  "dependencies": {
26
- "@docusaurus/logger": "0.0.0-4330",
26
+ "@docusaurus/logger": "0.0.0-4334",
27
27
  "commander": "^5.1.0",
28
28
  "fs-extra": "^10.0.0",
29
29
  "lodash": "^4.17.20",
@@ -39,5 +39,5 @@
39
39
  "devDependencies": {
40
40
  "@types/supports-color": "^8.1.1"
41
41
  },
42
- "gitHead": "ed4c0b5a082b72f8576bd7f7286dfb1a5c295edd"
42
+ "gitHead": "c7abfb389312cbce8e1af542c3bea6f11402b944"
43
43
  }
package/templates/classic/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docusaurus-2-classic-template",
3
- "version": "0.0.0-4330",
3
+ "version": "0.0.0-4334",
4
4
  "private": true,
5
5
  "scripts": {
6
6
  "docusaurus": "docusaurus",
@@ -14,8 +14,8 @@
14
14
  "write-heading-ids": "docusaurus write-heading-ids"
15
15
  },
16
16
  "dependencies": {
17
- "@docusaurus/core": "0.0.0-4330",
18
- "@docusaurus/preset-classic": "0.0.0-4330",
17
+ "@docusaurus/core": "0.0.0-4334",
18
+ "@docusaurus/preset-classic": "0.0.0-4334",
19
19
  "@mdx-js/react": "^1.6.21",
20
20
  "clsx": "^1.1.1",
21
21
  "prism-react-renderer": "^1.2.1",
package/templates/classic-typescript/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docusaurus-2-classic-typescript-template",
3
- "version": "0.0.0-4330",
3
+ "version": "0.0.0-4334",
4
4
  "private": true,
5
5
  "scripts": {
6
6
  "docusaurus": "docusaurus",
@@ -15,8 +15,8 @@
15
15
  "typecheck": "tsc"
16
16
  },
17
17
  "dependencies": {
18
- "@docusaurus/core": "0.0.0-4330",
19
- "@docusaurus/preset-classic": "0.0.0-4330",
18
+ "@docusaurus/core": "0.0.0-4334",
19
+ "@docusaurus/preset-classic": "0.0.0-4334",
20
20
  "@mdx-js/react": "^1.6.21",
21
21
  "clsx": "^1.1.1",
22
22
  "prism-react-renderer": "^1.2.1",
@@ -24,7 +24,7 @@
24
24
  "react-dom": "^17.0.1"
25
25
  },
26
26
  "devDependencies": {
27
- "@docusaurus/module-type-aliases": "0.0.0-4330",
27
+ "@docusaurus/module-type-aliases": "0.0.0-4334",
28
28
  "@tsconfig/docusaurus": "^1.0.4",
29
29
  "typescript": "^4.5.2"
30
30
  },
package/templates/facebook/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docusaurus-2-facebook-template",
3
- "version": "0.0.0-4330",
3
+ "version": "0.0.0-4334",
4
4
  "private": true,
5
5
  "scripts": {
6
6
  "docusaurus": "docusaurus",
@@ -18,8 +18,8 @@
18
18
  "format:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,md,mdx}\""
19
19
  },
20
20
  "dependencies": {
21
- "@docusaurus/core": "0.0.0-4330",
22
- "@docusaurus/preset-classic": "0.0.0-4330",
21
+ "@docusaurus/core": "0.0.0-4334",
22
+ "@docusaurus/preset-classic": "0.0.0-4334",
23
23
  "@mdx-js/react": "^1.6.21",
24
24
  "clsx": "^1.1.1",
25
25
  "react": "^17.0.1",
package/templates/shared/docs/intro.md CHANGED
@@ -12,24 +12,36 @@ Get started by **creating a new site**.
12
12
 
13
13
  Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
14
14
 
15
+ ### What you'll need
16
+
17
+ - [Node.js](https://nodejs.org/en/download/) version 14 or above:
18
+ - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
19
+
15
20
  ## Generate a new site
16
21
 
17
- Generate a new Docusaurus site using the **classic template**:
22
+ Generate a new Docusaurus site using the **classic template**.
18
23
 
19
- ```shell
24
+ The classic template will automatically be added to your project after you run the command:
25
+
26
+ ```bash
20
27
  npm init docusaurus@latest my-website classic
21
28
  ```
22
29
 
30
+ You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
31
+
32
+ The command also installs all necessary dependencies you need to run Docusaurus.
33
+
23
34
  ## Start your site
24
35
 
25
36
  Run the development server:
26
37
 
27
- ```shell
38
+ ```bash
28
39
  cd my-website
29
-
30
- npx docusaurus start
40
+ npm run start
31
41
  ```
32
42
 
33
- Your site starts at `http://localhost:3000`.
43
+ The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
44
+
45
+ The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
34
46
 
35
- Open `docs/intro.md` and edit some lines: the site **reloads automatically** and displays your changes.
47
+ Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.