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

docs(v2): various improvements

Browse source
This commit is contained in:
Alexey Pyltsyn 2020-04-28 17:44:06 +03:00
parent 753d117025
commit d41f8ca1a9
6 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/blog.md
View file

@ -147,7 +147,7 @@ module.exports = {
{
blog: {
path: './blog',
routeBasePath: '/', // Set this value to ''.
routeBasePath: '/', // Set this value to '/'.
},
},
],

8
website/docs/migrating-from-v1-to-v2.md
View file

@ -40,7 +40,7 @@ This provides a clear distinction between Docusaurus' official packages and comm
Meanwhile, the default doc site functionalities provided by Docusaurus 1 are now provided by `@docusaurus/preset-classic`. Therefore, we need to add this dependency as well:
```json title="package.json"
```diff title="package.json"
{
dependencies: {
- "docusaurus": "^1.x.x",
@ -428,7 +428,7 @@ In previous version, nested sidebar category is not allowed and sidebar category
You'll have to migrate your sidebar if it contains category type. Rename `subcategory` to `category` and `ids` to `items`.
```js title="sidebars.json"
```diff title="sidebars.json"
{
- type: 'subcategory',
+ type: 'category',
@ -571,7 +571,7 @@ Since we're going for snapshot and allow people to move (and edit) docs easily i
Essentially, here are the necessary changes in each versioned_docs file:
```yaml {2-3,5}
```diff {2-3,5}
---
- id: version-1.0.0-hello
+ id: hello
@ -615,7 +615,7 @@ So v1 users need to migrate their versioned_sidebars file
Example `versioned_sidebars/version-1.0.0-sidebars.json`:
```json {2-3,5-6,9-10} title="versioned_sidebars/version-1.0.0-sidebars.json"
```diff {2-3,5-6,9-10} title="versioned_sidebars/version-1.0.0-sidebars.json"
{
+ "version-1.0.0/docs": {
- "version-1.0.0-docs": {

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

@ -36,7 +36,7 @@ This provides a clear distinction between Docusaurus' official packages and comm
Meanwhile, the default doc site functionalities provided by Docusaurus 1 are now provided by `@docusaurus/preset-classic`. Therefore, we need to add this dependency as well:
```json
```diff
// package.json
{
dependencies: {
@ -435,7 +435,7 @@ In previous version, nested sidebar category is not allowed and sidebar category
You'll have to migrate your sidebar if it contains category type. Rename `subcategory` to `category` and `ids` to `items`.
```js
```diff
{
- type: 'subcategory',
+ type: 'category',
@ -578,7 +578,7 @@ Since we're going for snapshot and allow people to move (and edit) docs easily i
Essentially, here are the necessary changes in each versioned_docs file:
```yaml {2-3,5}
```diff {2-3,5}
---
- id: version-1.0.0-hello
+ id: hello
@ -622,7 +622,7 @@ So v1 users need to migrate their versioned_sidebars file
Example `versioned_sidebars/version-1.0.0-sidebars.json`:
```json {2-3,5-6,9-10}
```diff {2-3,5-6,9-10}
{
+ "version-1.0.0/docs": {
- "version-1.0.0-docs": {

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

@ -40,7 +40,7 @@ This provides a clear distinction between Docusaurus' official packages and comm
Meanwhile, the default doc site functionalities provided by Docusaurus 1 are now provided by `@docusaurus/preset-classic`. Therefore, we need to add this dependency as well:
```json title="package.json"
```diff title="package.json"
{
dependencies: {
- "docusaurus": "^1.x.x",
@ -428,7 +428,7 @@ In previous version, nested sidebar category is not allowed and sidebar category
You'll have to migrate your sidebar if it contains category type. Rename `subcategory` to `category` and `ids` to `items`.
```js
```diff
{
- type: 'subcategory',
+ type: 'category',
@ -571,7 +571,7 @@ Since we're going for snapshot and allow people to move (and edit) docs easily i
Essentially, here are the necessary changes in each versioned_docs file:
```yaml {2-3,5}
```diff {2-3,5}
---
- id: version-1.0.0-hello
+ id: hello
@ -615,7 +615,7 @@ So v1 users need to migrate their versioned_sidebars file
Example `versioned_sidebars/version-1.0.0-sidebars.json`:
```json {2-3,5-6,9-10}
```diff {2-3,5-6,9-10}
{
+ "version-1.0.0/docs": {
- "version-1.0.0-docs": {

2
website/versioned_docs/version-2.0.0-alpha.54/blog.md
View file

@ -147,7 +147,7 @@ module.exports = {
{
blog: {
path: './blog',
routeBasePath: '/', // Set this value to ''.
routeBasePath: '/', // Set this value to '/'.
},
},
],

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

@ -40,7 +40,7 @@ This provides a clear distinction between Docusaurus' official packages and comm
Meanwhile, the default doc site functionalities provided by Docusaurus 1 are now provided by `@docusaurus/preset-classic`. Therefore, we need to add this dependency as well:
```json title="package.json"
```diff title="package.json"
{
dependencies: {
- "docusaurus": "^1.x.x",
@ -428,7 +428,7 @@ In previous version, nested sidebar category is not allowed and sidebar category
You'll have to migrate your sidebar if it contains category type. Rename `subcategory` to `category` and `ids` to `items`.
```js title="sidebars.json"
```diff title="sidebars.json"
{
- type: 'subcategory',
+ type: 'category',
@ -571,7 +571,7 @@ Since we're going for snapshot and allow people to move (and edit) docs easily i
Essentially, here are the necessary changes in each versioned_docs file:
```yaml {2-3,5}
```diff {2-3,5}
---
- id: version-1.0.0-hello
+ id: hello
@ -615,7 +615,7 @@ So v1 users need to migrate their versioned_sidebars file
Example `versioned_sidebars/version-1.0.0-sidebars.json`:
```json {2-3,5-6,9-10} title="versioned_sidebars/version-1.0.0-sidebars.json"
```diff {2-3,5-6,9-10} title="versioned_sidebars/version-1.0.0-sidebars.json"
{
+ "version-1.0.0/docs": {
- "version-1.0.0-docs": {