3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-04 01:09:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: various fixes and improvements (#3546)

Browse source
This commit is contained in:
Alexey Pyltsyn 2020-10-07 13:39:47 +03:00 • committed by GitHub
parent 2e9854964d
commit 9134b1396b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
59 changed files with 230 additions and 225 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/versioned_docs/version-2.0.0-alpha.62/guides/creating-pages.md
View file

@ -69,7 +69,7 @@ In the same way, a page will be created at `http://localhost:3000/helloMarkdown`
Markdown pages are less flexible than React pages, because it always uses the theme layout.
Here's an [example markdown page](/examples/markdownPageExample).
Here's an [example Markdown page](/examples/markdownPageExample).
:::tip

8
website/versioned_docs/version-2.0.0-alpha.62/guides/migrating-from-v1-to-v2.md
View file

@ -361,7 +361,7 @@ Deprecated. Create a `CNAME` file in your `static` folder instead with your cust
#### `customDocsPath`, `docsUrl`, `editUrl`, `enableUpdateBy`, `enableUpdateTime`
**BREAKING**: `editUrl` should point to (website) docusaurus project instead of `docs` directory.
**BREAKING**: `editUrl` should point to (website) Docusaurus project instead of `docs` directory.
Deprecated. Pass it as an option to `@docusaurus/preset-classic` docs instead:
@ -689,11 +689,11 @@ yarn start
#### Options
You can add option flags to the migration command to automatically migrate markdown content and pages to v2. It is likely that you will still need to make some manual changes to achieve your desired result.
You can add option flags to the migration command to automatically migrate Markdown content and pages to v2. It is likely that you will still need to make some manual changes to achieve your desired result.
| Name | Description |
| -------- | ------------------------------------------------------ |
| `--mdx` | Add this flag to convert markdown to mdx automatically |
| `--mdx` | Add this flag to convert Markdown to MDX automatically |
| `--page` | Add this flag to migrate pages automatically |
```
@ -705,7 +705,7 @@ npx docusaurus-migrate migrate --mdx --page ./v1-website ./v2-website
The migration of pages and MDX is still a work in progress.
We recommend you to try to run the pages without these options, commit, and then try to run the migration again with the --page and --mdx options.
We recommend you to try to run the pages without these options, commit, and then try to run the migration again with the `--page` and `--mdx` options.
This way, you'd be able to easily inspect and fix the diff.