mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-20 20:46:58 +02:00
chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups (#4490)
* prepare v1-v2 domain switch * rename v1 changelog as CHANGELOG-1.x.md * switch v1/v2 changelogs * Cleanup v2.docusaurus.io urls * add netlify domain redirect * remove circleci config * remove another circle file
This commit is contained in:
Sébastien Lorber
GitHub
parent
aaea26602b
commit
78349480af
73 changed files with 109 additions and 217 deletions
|
|
@ -1,104 +0,0 @@
|
||||||
aliases:
|
|
||||||
- &root-yarn |
|
|
||||||
yarn install --non-interactive --cache-folder ~/.cache/yarn
|
|
||||||
|
|
||||||
- &root-restore-yarn-cache
|
|
||||||
keys:
|
|
||||||
- root-yarn-{{ .Branch }}-{{ checksum "yarn.lock" }}
|
|
||||||
# Fallback in case checksum fails
|
|
||||||
- root-yarn-{{ .Branch }}-
|
|
||||||
|
|
||||||
- &root-save-yarn-cache
|
|
||||||
paths:
|
|
||||||
- node_modules
|
|
||||||
- ~/.cache/yarn
|
|
||||||
key: root-yarn-{{ .Branch }}-{{ checksum "yarn.lock" }}
|
|
||||||
|
|
||||||
- &filter-only-master
|
|
||||||
branches:
|
|
||||||
only:
|
|
||||||
- master
|
|
||||||
|
|
||||||
defaults: &defaults
|
|
||||||
working_directory: ~/docusaurus
|
|
||||||
docker:
|
|
||||||
- image: circleci/node:12
|
|
||||||
resource_class: large
|
|
||||||
|
|
||||||
version: 2
|
|
||||||
jobs:
|
|
||||||
tests-v1:
|
|
||||||
<<: *defaults
|
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
- restore-cache: *root-restore-yarn-cache
|
|
||||||
- run: *root-yarn
|
|
||||||
- save-cache: *root-save-yarn-cache
|
|
||||||
- run:
|
|
||||||
name: Run Test Suites
|
|
||||||
command: yarn test:v1
|
|
||||||
|
|
||||||
# The CIRCLE_ variables are defined during the CircleCI build process
|
|
||||||
# https://circleci.com/docs/1.0/environment-variables/
|
|
||||||
deploy-website-v1:
|
|
||||||
<<: *defaults
|
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
- restore-cache: *root-restore-yarn-cache
|
|
||||||
- run: *root-yarn
|
|
||||||
- save-cache: *root-save-yarn-cache
|
|
||||||
- run:
|
|
||||||
name: Configure GitHub Bot
|
|
||||||
# Do not do this if we don't have the right org (facebook), or if this is just a pull request
|
|
||||||
command: |
|
|
||||||
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CIRCLE_PR_USERNAME ]]; then
|
|
||||||
git config --global user.email "docusaurus-bot@users.noreply.github.com"
|
|
||||||
git config --global user.name "Website Deployment Script"
|
|
||||||
echo "machine github.com login docusaurus-bot password $DOCUSAURUS_PUBLISH_TOKEN" > ~/.netrc
|
|
||||||
fi
|
|
||||||
- run:
|
|
||||||
name: Deploy v1 Website
|
|
||||||
# Skip the deploy if we don't have the right org (facebook), or if this is just a pull request
|
|
||||||
command: |
|
|
||||||
if ! git diff-tree --no-commit-id --name-only -r HEAD | grep -E "(crowdin-v1.yml)|(docusaurus-1\.x\/.*)|(website-1\.x\/.*)"; then
|
|
||||||
echo "Skipping deploy. No relevant v1 website files have changed"
|
|
||||||
elif [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CIRCLE_PR_USERNAME ]]; then
|
|
||||||
echo "Deploying website v1..."
|
|
||||||
cd website-1.x
|
|
||||||
|
|
||||||
# install Docusaurus and generate file of English strings
|
|
||||||
yarn run write-translations
|
|
||||||
|
|
||||||
# upload translation strings and download translations
|
|
||||||
# IMPORTANT: if this fails due to a Crowdin error like "Project already contains the file"
|
|
||||||
# Sometimes Crowdin refuse to upload the new versioned docs for obscure reasons
|
|
||||||
# Workaround: upload manually the new versioned files through the Crowdin UI...
|
|
||||||
# If the files already exist on Crowdin, the source upload will now work...
|
|
||||||
# All this has been extensively reported to their support already.
|
|
||||||
yarn crowdin-upload
|
|
||||||
|
|
||||||
# download only enabled languages
|
|
||||||
yarn crowdin-download
|
|
||||||
# for lang in fr ko ru ro pt-BR zh-CN
|
|
||||||
# do
|
|
||||||
# yarn crowdin-download -l $lang
|
|
||||||
# done
|
|
||||||
|
|
||||||
# publish
|
|
||||||
GIT_USER=docusaurus-bot USE_SSH=false FORCE_DEPLOY=true yarn run publish-gh-pages
|
|
||||||
else
|
|
||||||
echo "Skipping deploy."
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Workflows enables us to run multiple jobs in parallel
|
|
||||||
workflows:
|
|
||||||
version: 2
|
|
||||||
|
|
||||||
tests-and-deploy-v1:
|
|
||||||
jobs:
|
|
||||||
- tests-v1:
|
|
||||||
filters: *filter-only-master
|
|
||||||
- deploy-website-v1:
|
|
||||||
requires:
|
|
||||||
- tests-v1
|
|
||||||
filters: *filter-only-master
|
|
||||||
|
|
@ -2955,7 +2955,7 @@ If you are still encountering the error. Please check whether you use `module.ex
|
||||||
- Add missing dependencies on `@docusaurus/preset-classic`
|
- Add missing dependencies on `@docusaurus/preset-classic`
|
||||||
- New plugin `@docusaurus/plugin-ideal-image` to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder)
|
- New plugin `@docusaurus/plugin-ideal-image` to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder)
|
||||||
- Better Twitter/discord image preview. Previously the size is too zoomed
|
- Better Twitter/discord image preview. Previously the size is too zoomed
|
||||||
- Allow prism syntax highlighting theme customization. Refer to https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting
|
- Allow prism syntax highlighting theme customization. Refer to https://docusaurus.io/docs/markdown-features#syntax-highlighting
|
||||||
- CSS is now autoprefixed using postcss
|
- CSS is now autoprefixed using postcss
|
||||||
- Faster, lighter webpack bundle size
|
- Faster, lighter webpack bundle size
|
||||||
- `@docusaurus/theme-live-codeblock` is now much smaller in size and no longer only load on viewport
|
- `@docusaurus/theme-live-codeblock` is now much smaller in size and no longer only load on viewport
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Contributing to Docusaurus
|
# Contributing to Docusaurus
|
||||||
|
|
||||||
[Docusaurus](https://docusaurus.io) is our way to hopefully help to create open source documentation easier. We currently have [multiple open source projects using it](https://v2.docusaurus.io/showcase), with many more planned. If you're interested in contributing to Docusaurus, hopefully, this document makes the process for contributing clear.
|
[Docusaurus](https://docusaurus.io) is our way to hopefully help to create open source documentation easier. We currently have [multiple open source projects using it](https://docusaurus.io/showcase), with many more planned. If you're interested in contributing to Docusaurus, hopefully, this document makes the process for contributing clear.
|
||||||
|
|
||||||
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
||||||
|
|
||||||
|
|
@ -15,10 +15,10 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad
|
||||||
|
|
||||||
There are many ways to contribute to Docusaurus, and many of them do not involve writing any code. Here's a few ideas to get started:
|
There are many ways to contribute to Docusaurus, and many of them do not involve writing any code. Here's a few ideas to get started:
|
||||||
|
|
||||||
- Simply start using Docusaurus. Go through the [Getting Started](https://v2.docusaurus.io/docs/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
|
- Simply start using Docusaurus. Go through the [Getting Started](https://docusaurus.io/docs/installation) guide. Does everything work as expected? If not, we're always looking for improvements. Let us know by [opening an issue](#reporting-new-issues).
|
||||||
- Look through the [open issues](https://github.com/facebook/docusaurus/issues). Provide workarounds, ask for clarification, or suggest labels. Help [triage issues](#triaging-issues-and-pull-requests).
|
- Look through the [open issues](https://github.com/facebook/docusaurus/issues). Provide workarounds, ask for clarification, or suggest labels. Help [triage issues](#triaging-issues-and-pull-requests).
|
||||||
- If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). Issues tagged as [_Good first issue_](https://github.com/facebook/docusaurus/labels/Good%20first%20issue) are a good place to get started.
|
- If you find an issue you would like to fix, [open a pull request](#your-first-pull-request). Issues tagged as [_Good first issue_](https://github.com/facebook/docusaurus/labels/Good%20first%20issue) are a good place to get started.
|
||||||
- Read through the [Docusaurus docs](https://v2.docusaurus.io/docs/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the top of most docs.
|
- Read through the [Docusaurus docs](https://docusaurus.io/docs/installation). If you find anything that is confusing or can be improved, you can make edits by clicking "Edit" at the top of most docs.
|
||||||
- Take a look at the [features requested](https://github.com/facebook/docusaurus/labels/enhancement) by others in the community and consider opening a pull request if you see something you want to work on.
|
- Take a look at the [features requested](https://github.com/facebook/docusaurus/labels/enhancement) by others in the community and consider opening a pull request if you see something you want to work on.
|
||||||
|
|
||||||
Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@docusaurus](https://twitter.com/docusaurus) and let us know you are looking for a bit of help.
|
Contributions are very welcome. If you think you need help planning your contribution, please ping us on Twitter at [@docusaurus](https://twitter.com/docusaurus) and let us know you are looking for a bit of help.
|
||||||
|
|
@ -27,8 +27,8 @@ Contributions are very welcome. If you think you need help planning your contrib
|
||||||
|
|
||||||
If you only want to make content changes you just need to know about versioned docs.
|
If you only want to make content changes you just need to know about versioned docs.
|
||||||
|
|
||||||
- `website/docs` - The files in here are responsible for the "next" version at https://v2.docusaurus.io/docs/next/installation.
|
- `website/docs` - The files in here are responsible for the "next" version at https://docusaurus.io/docs/next/installation.
|
||||||
- `website/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://v2.docusaurus.io/docs/X.Y.Z/installation.
|
- `website/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://docusaurus.io/docs/X.Y.Z/installation.
|
||||||
|
|
||||||
To make a fix to the published versions you must edit the corresponding markdown file in both folders. If you only made changes in `docs`, be sure to be viewing the `next` version to see the updates (ensure there's `next` in the URL).
|
To make a fix to the published versions you must edit the corresponding markdown file in both folders. If you only made changes in `docs`, be sure to be viewing the `next` version to see the updates (ensure there's `next` in the URL).
|
||||||
|
|
||||||
|
|
|
||||||
10
README.md
10
README.md
|
|
@ -19,7 +19,9 @@
|
||||||
<a href="https://meercode.io/facebook/docusaurus"><img src="https://meercode.io/badge/facebook/docusaurus?type=ci-score" alt="CI Score"></a>
|
<a href="https://meercode.io/facebook/docusaurus"><img src="https://meercode.io/badge/facebook/docusaurus?type=ci-score" alt="CI Score"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
> **We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the [Docusaurus v2 website](https://v2.docusaurus.io/) for more details.**
|
> **We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the [Docusaurus v2 website](https://docusaurus.io/) for more details.**
|
||||||
|
|
||||||
|
> Docusaurus v1 doc is available at [v1.docusaurus.io](https://v1.docusaurus.io)
|
||||||
|
|
||||||
> Docusaurus v1 doc is available at [v1.docusaurus.io](https://v1.docusaurus.io)
|
> Docusaurus v1 doc is available at [v1.docusaurus.io](https://v1.docusaurus.io)
|
||||||
|
|
||||||
|
|
@ -31,15 +33,15 @@ Docusaurus is a project for building, deploying, and maintaining open source pro
|
||||||
|
|
||||||
- **Simple to Start**
|
- **Simple to Start**
|
||||||
|
|
||||||
> Docusaurus is built in a way so that it can [get running](https://v2.docusaurus.io/docs/installation) in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.
|
> Docusaurus is built in a way so that it can [get running](https://docusaurus.io/docs/installation) in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.
|
||||||
|
|
||||||
- **Localizable**
|
- **Localizable**
|
||||||
|
|
||||||
> Docusaurus ships with [localization support](https://v2.docusaurus.io/docs/i18n/introduction) via CrowdIn. Empower and grow your international community by translating your documentation.
|
> Docusaurus ships with [localization support](https://docusaurus.io/docs/i18n/introduction) via CrowdIn. Empower and grow your international community by translating your documentation.
|
||||||
|
|
||||||
- **Customizable**
|
- **Customizable**
|
||||||
|
|
||||||
> While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://v2.docusaurus.io/docs/blog), and additional support pages, it is also [customizable](https://v2.docusaurus.io/docs/creating-pages) as well to ensure you have a site that is [uniquely yours](https://v2.docusaurus.io/docs/styling-layout).
|
> While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/blog), and additional support pages, it is also [customizable](https://docusaurus.io/docs/creating-pages) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/styling-layout).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Create Docusaurus apps easily.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Please see the [installation documentation](https://v2.docusaurus.io/docs/installation).
|
Please see the [installation documentation](https://docusaurus.io/docs/installation).
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Website
|
# Website
|
||||||
|
|
||||||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
|
||||||
tags: [hello, docusaurus]
|
tags: [hello, docusaurus]
|
||||||
---
|
---
|
||||||
|
|
||||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
|
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,4 +12,4 @@ You can use our blog plugin to do your posts
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
If you want add your own component, you can use the `swizzle` command. Check more at our [doc](https://v2.docusaurus.io/docs/using-themes#swizzling-theme-components)
|
If you want add your own component, you can use the `swizzle` command. Check more at our [doc](https://docusaurus.io/docs/using-themes#swizzling-theme-components)
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Website
|
# Website
|
||||||
|
|
||||||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
|
||||||
tags: [hello, docusaurus]
|
tags: [hello, docusaurus]
|
||||||
---
|
---
|
||||||
|
|
||||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
|
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,8 +12,8 @@ Have 5 more minutes? Take a look at **[versioning](./manage-docs-versions.md)**
|
||||||
|
|
||||||
## What's next?
|
## What's next?
|
||||||
|
|
||||||
- Read the [official documentation](https://v2.docusaurus.io/).
|
- Read the [official documentation](https://docusaurus.io/).
|
||||||
- Add a custom [Design and Layout](https://v2.docusaurus.io/docs/styling-layout)
|
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||||
- Add a [search bar](https://v2.docusaurus.io/docs/search)
|
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||||
- Find inspirations in the [Docusaurus showcase](https://v2.docusaurus.io/showcase)
|
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||||
- Get involved in the [Docusaurus Community](https://v2.docusaurus.io/community/support)
|
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||||
|
|
|
||||||
|
|
@ -24,4 +24,4 @@ npm run serve
|
||||||
|
|
||||||
The `build` folder is now served at `http://localhost:3000/`.
|
The `build` folder is now served at `http://localhost:3000/`.
|
||||||
|
|
||||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://v2.docusaurus.io/docs/deployment)**).
|
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# Website
|
# Website
|
||||||
|
|
||||||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
|
||||||
tags: [hello, docusaurus]
|
tags: [hello, docusaurus]
|
||||||
---
|
---
|
||||||
|
|
||||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
|
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ A CLI tool to migrate from older versions of Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Please see [the migration documentation](https://v2.docusaurus.io/docs/migration) for more information.
|
Please see [the migration documentation](https://docusaurus.io/docs/migration) for more information.
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Client redirects plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-client-redirects documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects).
|
See [plugin-client-redirects documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Blog plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-content-blog documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
|
See [plugin-content-blog documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Docs plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-content-docs documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs).
|
See [plugin-content-docs documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Pages plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-content-pages documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages).
|
See [plugin-content-pages documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Debug plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-debug documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-debug).
|
See [plugin-debug documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-debug).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Google analytics plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-google-analytics documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-analytics).
|
See [plugin-google-analytics documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-analytics).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Global Site Tag (gtag.js) plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-google-gtag documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag).
|
See [plugin-google-gtag documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Progressive web app plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-pwa documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa).
|
See [plugin-pwa documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Simple sitemap generation plugin for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [plugin-sitemap documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap).
|
See [plugin-sitemap documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Bootstrap preset for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [presets documentation](https://v2.docusaurus.io/docs/presets).
|
See [presets documentation](https://docusaurus.io/docs/presets).
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Classic preset for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [presets documentation](https://v2.docusaurus.io/docs/presets).
|
See [presets documentation](https://docusaurus.io/docs/presets).
|
||||||
|
|
|
||||||
|
|
@ -62,4 +62,4 @@ module.exports = {
|
||||||
|
|
||||||
| Property | Type | Default | Description |
|
| Property | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| `sync` | `boolean` | `false` | Syncing tab choices (yarn and npm). See https://v2.docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |
|
| `sync` | `boolean` | `false` | Syncing tab choices (yarn and npm). See https://docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ function useThemeContext(): ThemeContextProps {
|
||||||
const context = useContext<ThemeContextProps | undefined>(ThemeContext);
|
const context = useContext<ThemeContextProps | undefined>(ThemeContext);
|
||||||
if (context == null) {
|
if (context == null) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
'`useThemeContext` is used outside of `Layout` Component. See https://v2.docusaurus.io/docs/api/themes/configuration#usethemecontext.',
|
'`useThemeContext` is used outside of `Layout` Component. See https://docusaurus.io/docs/api/themes/configuration#usethemecontext.',
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
return context;
|
return context;
|
||||||
|
|
|
||||||
|
|
@ -4,4 +4,4 @@ Algolia search component for Docusaurus.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See [`@docusaurus/theme-search-algolia` documentation](https://v2.docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia).
|
See [`@docusaurus/theme-search-algolia` documentation](https://docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia).
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ function createInlineHtmlBanner(baseUrl: string) {
|
||||||
return `
|
return `
|
||||||
<div id="${BannerId}" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">
|
<div id="${BannerId}" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">
|
||||||
<p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>
|
<p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>
|
||||||
<p>A very common reason is a wrong site <a href="https://v2.docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>
|
<p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseurl" style="font-weight: bold;">baseUrl configuration</a>.</p>
|
||||||
<p>Current configured baseUrl = <span style="font-weight: bold; color: red;">${baseUrl}</span> ${
|
<p>Current configured baseUrl = <span style="font-weight: bold; color: red;">${baseUrl}</span> ${
|
||||||
baseUrl === '/' ? ' (default value)' : ''
|
baseUrl === '/' ? ' (default value)' : ''
|
||||||
}</p>
|
}</p>
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ describe('useBaseUrl', () => {
|
||||||
mockedContext.mockImplementation(() => ({
|
mockedContext.mockImplementation(() => ({
|
||||||
siteConfig: {
|
siteConfig: {
|
||||||
baseUrl: '/',
|
baseUrl: '/',
|
||||||
url: 'https://v2.docusaurus.io',
|
url: 'https://docusaurus.io',
|
||||||
},
|
},
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
|
@ -38,7 +38,7 @@ describe('useBaseUrl', () => {
|
||||||
'https://site.com',
|
'https://site.com',
|
||||||
);
|
);
|
||||||
expect(useBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
expect(useBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
||||||
'https://v2.docusaurus.io/hello/byebye',
|
'https://docusaurus.io/hello/byebye',
|
||||||
);
|
);
|
||||||
expect(useBaseUrl('#hello')).toEqual('#hello');
|
expect(useBaseUrl('#hello')).toEqual('#hello');
|
||||||
});
|
});
|
||||||
|
|
@ -47,7 +47,7 @@ describe('useBaseUrl', () => {
|
||||||
mockedContext.mockImplementation(() => ({
|
mockedContext.mockImplementation(() => ({
|
||||||
siteConfig: {
|
siteConfig: {
|
||||||
baseUrl: '/docusaurus/',
|
baseUrl: '/docusaurus/',
|
||||||
url: 'https://v2.docusaurus.io',
|
url: 'https://docusaurus.io',
|
||||||
},
|
},
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
|
@ -66,7 +66,7 @@ describe('useBaseUrl', () => {
|
||||||
'https://site.com',
|
'https://site.com',
|
||||||
);
|
);
|
||||||
expect(useBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
expect(useBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
||||||
'https://v2.docusaurus.io/docusaurus/hello/byebye',
|
'https://docusaurus.io/docusaurus/hello/byebye',
|
||||||
);
|
);
|
||||||
expect(useBaseUrl('/docusaurus/')).toEqual('/docusaurus/');
|
expect(useBaseUrl('/docusaurus/')).toEqual('/docusaurus/');
|
||||||
expect(useBaseUrl('/docusaurus/hello')).toEqual('/docusaurus/hello');
|
expect(useBaseUrl('/docusaurus/hello')).toEqual('/docusaurus/hello');
|
||||||
|
|
@ -79,7 +79,7 @@ describe('useBaseUrlUtils().withBaseUrl()', () => {
|
||||||
mockedContext.mockImplementation(() => ({
|
mockedContext.mockImplementation(() => ({
|
||||||
siteConfig: {
|
siteConfig: {
|
||||||
baseUrl: '/',
|
baseUrl: '/',
|
||||||
url: 'https://v2.docusaurus.io',
|
url: 'https://docusaurus.io',
|
||||||
},
|
},
|
||||||
}));
|
}));
|
||||||
const {withBaseUrl} = useBaseUrlUtils();
|
const {withBaseUrl} = useBaseUrlUtils();
|
||||||
|
|
@ -99,7 +99,7 @@ describe('useBaseUrlUtils().withBaseUrl()', () => {
|
||||||
'https://site.com',
|
'https://site.com',
|
||||||
);
|
);
|
||||||
expect(withBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
expect(withBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
||||||
'https://v2.docusaurus.io/hello/byebye',
|
'https://docusaurus.io/hello/byebye',
|
||||||
);
|
);
|
||||||
expect(withBaseUrl('#hello')).toEqual('#hello');
|
expect(withBaseUrl('#hello')).toEqual('#hello');
|
||||||
});
|
});
|
||||||
|
|
@ -108,7 +108,7 @@ describe('useBaseUrlUtils().withBaseUrl()', () => {
|
||||||
mockedContext.mockImplementation(() => ({
|
mockedContext.mockImplementation(() => ({
|
||||||
siteConfig: {
|
siteConfig: {
|
||||||
baseUrl: '/docusaurus/',
|
baseUrl: '/docusaurus/',
|
||||||
url: 'https://v2.docusaurus.io',
|
url: 'https://docusaurus.io',
|
||||||
},
|
},
|
||||||
}));
|
}));
|
||||||
const {withBaseUrl} = useBaseUrlUtils();
|
const {withBaseUrl} = useBaseUrlUtils();
|
||||||
|
|
@ -128,7 +128,7 @@ describe('useBaseUrlUtils().withBaseUrl()', () => {
|
||||||
'https://site.com',
|
'https://site.com',
|
||||||
);
|
);
|
||||||
expect(withBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
expect(withBaseUrl('/hello/byebye', {absolute: true})).toEqual(
|
||||||
'https://v2.docusaurus.io/docusaurus/hello/byebye',
|
'https://docusaurus.io/docusaurus/hello/byebye',
|
||||||
);
|
);
|
||||||
expect(withBaseUrl('/docusaurus/')).toEqual('/docusaurus/');
|
expect(withBaseUrl('/docusaurus/')).toEqual('/docusaurus/');
|
||||||
expect(withBaseUrl('/docusaurus/hello')).toEqual('/docusaurus/hello');
|
expect(withBaseUrl('/docusaurus/hello')).toEqual('/docusaurus/hello');
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ exports[`loadConfig website with useless field (wrong field) in siteConfig 1`] =
|
||||||
"\\"favicon\\" is required
|
"\\"favicon\\" is required
|
||||||
These field(s) [\\"useLessField\\",] are not recognized in docusaurus.config.js.
|
These field(s) [\\"useLessField\\",] are not recognized in docusaurus.config.js.
|
||||||
If you still want these fields to be in your configuration, put them in the 'customFields' attribute.
|
If you still want these fields to be in your configuration, put them in the 'customFields' attribute.
|
||||||
See https://v2.docusaurus.io/docs/docusaurus.config.js/#customfields"
|
See https://docusaurus.io/docs/docusaurus.config.js/#customfields"
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`loadConfig website with valid siteConfig 1`] = `
|
exports[`loadConfig website with valid siteConfig 1`] = `
|
||||||
|
|
|
||||||
|
|
@ -16,13 +16,13 @@ exports[`normalizeConfig should throw error for required fields 1`] = `
|
||||||
\\"stylesheets\\" must be an array
|
\\"stylesheets\\" must be an array
|
||||||
These field(s) [\\"invalidField\\",] are not recognized in docusaurus.config.js.
|
These field(s) [\\"invalidField\\",] are not recognized in docusaurus.config.js.
|
||||||
If you still want these fields to be in your configuration, put them in the 'customFields' attribute.
|
If you still want these fields to be in your configuration, put them in the 'customFields' attribute.
|
||||||
See https://v2.docusaurus.io/docs/docusaurus.config.js/#customfields"
|
See https://docusaurus.io/docs/docusaurus.config.js/#customfields"
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`normalizeConfig should throw error for unknown field 1`] = `
|
exports[`normalizeConfig should throw error for unknown field 1`] = `
|
||||||
"These field(s) [\\"invalid\\",] are not recognized in docusaurus.config.js.
|
"These field(s) [\\"invalid\\",] are not recognized in docusaurus.config.js.
|
||||||
If you still want these fields to be in your configuration, put them in the 'customFields' attribute.
|
If you still want these fields to be in your configuration, put them in the 'customFields' attribute.
|
||||||
See https://v2.docusaurus.io/docs/docusaurus.config.js/#customfields"
|
See https://docusaurus.io/docs/docusaurus.config.js/#customfields"
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`normalizeConfig should throw error if css doesn't have href 1`] = `
|
exports[`normalizeConfig should throw error if css doesn't have href 1`] = `
|
||||||
|
|
|
||||||
|
|
@ -164,7 +164,7 @@ export function validateConfig(
|
||||||
'',
|
'',
|
||||||
);
|
);
|
||||||
formattedError = unknownFields
|
formattedError = unknownFields
|
||||||
? `${formattedError}These field(s) [${unknownFields}] are not recognized in ${DEFAULT_CONFIG_FILE_NAME}.\nIf you still want these fields to be in your configuration, put them in the 'customFields' attribute.\nSee https://v2.docusaurus.io/docs/docusaurus.config.js/#customfields`
|
? `${formattedError}These field(s) [${unknownFields}] are not recognized in ${DEFAULT_CONFIG_FILE_NAME}.\nIf you still want these fields to be in your configuration, put them in the 'customFields' attribute.\nSee https://docusaurus.io/docs/docusaurus.config.js/#customfields`
|
||||||
: formattedError;
|
: formattedError;
|
||||||
throw new Error(formattedError);
|
throw new Error(formattedError);
|
||||||
} else {
|
} else {
|
||||||
|
|
|
||||||
|
|
@ -59,7 +59,7 @@ export default function initPlugins({
|
||||||
throw new TypeError(`You supplied a wrong type of plugin.
|
throw new TypeError(`You supplied a wrong type of plugin.
|
||||||
A plugin should be either string or [importPath: string, options?: object].
|
A plugin should be either string or [importPath: string, options?: object].
|
||||||
|
|
||||||
For more information, visit https://v2.docusaurus.io/docs/using-plugins.`);
|
For more information, visit https://docusaurus.io/docs/using-plugins.`);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!pluginModuleImport) {
|
if (!pluginModuleImport) {
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ authorTwitter: yangshunz
|
||||||
tags: [recap]
|
tags: [recap]
|
||||||
---
|
---
|
||||||
|
|
||||||
2019 was a great year for Docusaurus - we've made tremendous progress on [Docusaurus 2](https://v2.docusaurus.io/). Current Docusaurus 1 users who aren't using the translations feature can feel free to check it out and [migrate](https://v2.docusaurus.io/docs/migration) to it! Otherwise we will work with you to make that happen in 2020 :)
|
2019 was a great year for Docusaurus - we've made tremendous progress on [Docusaurus 2](https://docusaurus.io/). Current Docusaurus 1 users who aren't using the translations feature can feel free to check it out and [migrate](https://docusaurus.io/docs/migration) to it! Otherwise we will work with you to make that happen in 2020 :)
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
@ -58,7 +58,7 @@ A few third-party hosting/development services also has first-class integration
|
||||||
|
|
||||||
## Looking Ahead
|
## Looking Ahead
|
||||||
|
|
||||||
D2 has gained some traction among the [developer community](https://v2.docusaurus.io/showcase). In 2020, we want to achieve full feature parity with D1 by the first half and help the remaining Facebook projects on D1 move to D2. It would also be great if we could use Docusaurus for internal documentation, but that is a non-trivial undertaking. If you have a need for it or have some ideas, come speak with us!
|
D2 has gained some traction among the [developer community](https://docusaurus.io/showcase). In 2020, we want to achieve full feature parity with D1 by the first half and help the remaining Facebook projects on D1 move to D2. It would also be great if we could use Docusaurus for internal documentation, but that is a non-trivial undertaking. If you have a need for it or have some ideas, come speak with us!
|
||||||
|
|
||||||
Huge thanks to the community for their contributions, especially the core team - [Endilie Yacop Sucipto](https://github.com/endiliey), [Alexey Pyltsyn](https://github.com/lex111), [Wei Gao](https://github.com/wgao19). Lastly, thank you [Joel Marcey](https://github.com/JoelMarcey) for starting Docusaurus and supporting the project all this time.
|
Huge thanks to the community for their contributions, especially the core team - [Endilie Yacop Sucipto](https://github.com/endiliey), [Alexey Pyltsyn](https://github.com/lex111), [Wei Gao](https://github.com/wgao19). Lastly, thank you [Joel Marcey](https://github.com/JoelMarcey) for starting Docusaurus and supporting the project all this time.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,9 +11,9 @@ image: /img/docusaurus-2020-recap.png
|
||||||
|
|
||||||
**2020 was great for Docusaurus**, despite [a regrettable start](https://docusaurus.io/blog/2020/01/07/tribute-to-endi) and a tumultuous year for everyone.
|
**2020 was great for Docusaurus**, despite [a regrettable start](https://docusaurus.io/blog/2020/01/07/tribute-to-endi) and a tumultuous year for everyone.
|
||||||
|
|
||||||
We continued to invest in [Docusaurus 2](https://v2.docusaurus.io/), and made it reach **full feature parity** with [Docusaurus 1](https://v1.docusaurus.io/).
|
We continued to invest in [Docusaurus 2](https://docusaurus.io/), and made it reach **full feature parity** with [Docusaurus 1](https://v1.docusaurus.io/).
|
||||||
|
|
||||||
We now **recommend Docusaurus 2** as the **default choice** to start a new Docusaurus project and encourage v1 users to [migrate to Docusaurus 2](https://v2.docusaurus.io/docs/migration).
|
We now **recommend Docusaurus 2** as the **default choice** to start a new Docusaurus project and encourage v1 users to [migrate to Docusaurus 2](https://docusaurus.io/docs/migration).
|
||||||
|
|
||||||
We are **still in alpha**, but expect **some good news very soon**!
|
We are **still in alpha**, but expect **some good news very soon**!
|
||||||
|
|
||||||
|
|
@ -25,7 +25,7 @@ We are **still in alpha**, but expect **some good news very soon**!
|
||||||
|
|
||||||
We have worked on many features this year, and would like to highlight the most significant ones:
|
We have worked on many features this year, and would like to highlight the most significant ones:
|
||||||
|
|
||||||
- **i18n**: easily translate your Docusaurus site, released soon! ([preview](https://github.com/facebook/docusaurus/pull/3325), [doc](https://v2.docusaurus.io/docs/next/i18n/introduction))
|
- **i18n**: easily translate your Docusaurus site, released soon! ([preview](https://github.com/facebook/docusaurus/pull/3325), [doc](https://docusaurus.io/docs/next/i18n/introduction))
|
||||||
- **Version dropdown**: enable contextual version switch
|
- **Version dropdown**: enable contextual version switch
|
||||||
- **Versioning options**: solving the most common pain-points users had with versioning
|
- **Versioning options**: solving the most common pain-points users had with versioning
|
||||||
- **Contextual search**: search in the current version, use the brand-new DocSearch 3 experience
|
- **Contextual search**: search in the current version, use the brand-new DocSearch 3 experience
|
||||||
|
|
@ -46,7 +46,7 @@ The plan to [rebuild Docusaurus from scratch in 2019](https://docusaurus.io/blog
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Notable **projects, startups, large companies, and individuals** adopted Docusaurus 2 ([showcase](https://v2.docusaurus.io/showcase)):
|
Notable **projects, startups, large companies, and individuals** adopted Docusaurus 2 ([showcase](https://docusaurus.io/showcase)):
|
||||||
|
|
||||||
- [Supabase](https://supabase.io)
|
- [Supabase](https://supabase.io)
|
||||||
- [React Navigation](https://reactnavigation.org)
|
- [React Navigation](https://reactnavigation.org)
|
||||||
|
|
@ -111,7 +111,7 @@ Many blog posts have been published:
|
||||||
|
|
||||||
The Docusaurus community continues to grow, the [Discord](https://discord.gg/docusaurus) server is quite active, and [Stack Overflow questions](https://stackoverflow.com/questions/tagged/docusaurus) keep being posted.
|
The Docusaurus community continues to grow, the [Discord](https://discord.gg/docusaurus) server is quite active, and [Stack Overflow questions](https://stackoverflow.com/questions/tagged/docusaurus) keep being posted.
|
||||||
|
|
||||||
The **modular architecture** of Docusaurus 2 allowed the community to build and publish [third-party plugins](https://v2.docusaurus.io/community/resources#community-plugins-). As we would like to federate better our community, if you are building a plugin, please [let us know](https://github.com/facebook/docusaurus/discussions/4025).
|
The **modular architecture** of Docusaurus 2 allowed the community to build and publish [third-party plugins](https://docusaurus.io/community/resources#community-plugins-). As we would like to federate better our community, if you are building a plugin, please [let us know](https://github.com/facebook/docusaurus/discussions/4025).
|
||||||
|
|
||||||
## What's next?
|
## What's next?
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ tags: [release, i18n]
|
||||||
image: /img/blog/2021-03-09-releasing-docusaurus-i18n/social-card.png
|
image: /img/blog/2021-03-09-releasing-docusaurus-i18n/social-card.png
|
||||||
---
|
---
|
||||||
|
|
||||||
Today, we officially release **[Docusaurus 2 i18n](https://v2.docusaurus.io/docs/i18n/introduction)** ([internationalization](https://en.wikipedia.org/wiki/Internationalization_and_localization)), as part of [2.0.0-alpha.71](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-alpha.71).
|
Today, we officially release **[Docusaurus 2 i18n](https://docusaurus.io/docs/i18n/introduction)** ([internationalization](https://en.wikipedia.org/wiki/Internationalization_and_localization)), as part of [2.0.0-alpha.71](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-alpha.71).
|
||||||
|
|
||||||
Docusaurus 2 has now reached **full feature parity with Docusaurus 1**. 🎉 And soon, after a few additional infrastructure updates and a bit more testing, the **first Docusaurus 2 beta** will be released.
|
Docusaurus 2 has now reached **full feature parity with Docusaurus 1**. 🎉 And soon, after a few additional infrastructure updates and a bit more testing, the **first Docusaurus 2 beta** will be released.
|
||||||
|
|
||||||
|
|
@ -17,7 +17,7 @@ Docusaurus 2 has now reached **full feature parity with Docusaurus 1**. 🎉 And
|
||||||
|
|
||||||
In this post, we will present you the **translation workflow**, explain some **design decisions** and **showcase early adopter sites** that just went live: [Jest](https://jestjs.io/), [Redwood](https://learn.redwoodjs.com/), and [Datagit](https://datagit.ir/).
|
In this post, we will present you the **translation workflow**, explain some **design decisions** and **showcase early adopter sites** that just went live: [Jest](https://jestjs.io/), [Redwood](https://learn.redwoodjs.com/), and [Datagit](https://datagit.ir/).
|
||||||
|
|
||||||
We also **dogfood** the i18n support on the **Docusaurus 2 site itself**, and this post is already available in [English](https://v2.docusaurus.io/blog/2021/03/09/releasing-docusaurus-i18n) and [French](https://v2.docusaurus.io/fr/blog/2021/03/09/releasing-docusaurus-i18n)!
|
We also **dogfood** the i18n support on the **Docusaurus 2 site itself**, and this post is already available in [English](https://docusaurus.io/blog/2021/03/09/releasing-docusaurus-i18n) and [French](https://docusaurus.io/fr/blog/2021/03/09/releasing-docusaurus-i18n)!
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
@ -26,18 +26,18 @@ We also **dogfood** the i18n support on the **Docusaurus 2 site itself**, and th
|
||||||
You can translate a Docusaurus site in **3 simple steps**:
|
You can translate a Docusaurus site in **3 simple steps**:
|
||||||
|
|
||||||
1. **Configure**: declare the default locale and alternative locales in `docusaurus.config.js`
|
1. **Configure**: declare the default locale and alternative locales in `docusaurus.config.js`
|
||||||
1. **Translate**: put the translation files at the [correct filesystem location](https://v2.docusaurus.io/docs/next/i18n/introduction#translation-files-location)
|
1. **Translate**: put the translation files at the [correct filesystem location](https://docusaurus.io/docs/next/i18n/introduction#translation-files-location)
|
||||||
1. **Deploy**: build and deploy your site using a single or multi-domain strategy
|
1. **Deploy**: build and deploy your site using a single or multi-domain strategy
|
||||||
|
|
||||||
The i18n support is **very flexible** and based on the **filesystem**.
|
The i18n support is **very flexible** and based on the **filesystem**.
|
||||||
|
|
||||||
The **[i18n tutorial](https://v2.docusaurus.io/docs/i18n/tutorial)** is the best way to get started, and we provide help to use **[Git](https://v2.docusaurus.io/docs/i18n/git)** or **[Crowdin](https://v2.docusaurus.io/docs/i18n/crowdin)**.
|
The **[i18n tutorial](https://docusaurus.io/docs/i18n/tutorial)** is the best way to get started, and we provide help to use **[Git](https://docusaurus.io/docs/i18n/git)** or **[Crowdin](https://docusaurus.io/docs/i18n/crowdin)**.
|
||||||
|
|
||||||
## Design decisions
|
## Design decisions
|
||||||
|
|
||||||
The goals of the Docusaurus i18n system are:
|
The goals of the Docusaurus i18n system are:
|
||||||
|
|
||||||
- **Simple**: just put the translated files in the [correct filesystem location](https://v2.docusaurus.io/docs/next/i18n/introduction#translation-files-location)
|
- **Simple**: just put the translated files in the [correct filesystem location](https://docusaurus.io/docs/next/i18n/introduction#translation-files-location)
|
||||||
- **Flexible translation workflows**: use Git (monorepo, forks, or submodules), SaaS software, FTP
|
- **Flexible translation workflows**: use Git (monorepo, forks, or submodules), SaaS software, FTP
|
||||||
- **Flexible deployment options**: single, multiple domains, or hybrid
|
- **Flexible deployment options**: single, multiple domains, or hybrid
|
||||||
- **Modular**: allow plugin authors to provide i18n support
|
- **Modular**: allow plugin authors to provide i18n support
|
||||||
|
|
@ -95,4 +95,4 @@ This feature has not been an easy one, and we would like to thank everyone that
|
||||||
|
|
||||||
Thanks for reading.
|
Thanks for reading.
|
||||||
|
|
||||||
🙏 And please, add your brand new i18n sites to our [showcase page](https://v2.docusaurus.io/showcase). We accept any all polished Docusaurus site here, and we are working on a [redesign](https://github.com/facebook/docusaurus/issues/4238) allowing you to filter sites by features.
|
🙏 And please, add your brand new i18n sites to our [showcase page](https://docusaurus.io/showcase). We accept any all polished Docusaurus site here, and we are working on a [redesign](https://github.com/facebook/docusaurus/issues/4238) allowing you to filter sites by features.
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@ description: Docusaurus was designed from the ground up to be easily installed a
|
||||||
|
|
||||||
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
||||||
|
|
||||||
> **Important Note:** we highly encourage you to use [Docusaurus 2](https://v2.docusaurus.io) instead.
|
> **Important Note:** we highly encourage you to use [Docusaurus 2](https://docusaurus.io) instead.
|
||||||
|
|
||||||
## Installing Docusaurus
|
## Installing Docusaurus
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -71,7 +71,7 @@ class Index extends React.Component {
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
We now recommend using{' '}
|
We now recommend using{' '}
|
||||||
<a href="https://v2.docusaurus.io">Docusaurus 2</a> instead!
|
<a href="https://docusaurus.io">Docusaurus 2</a> instead!
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
||||||
|
|
@ -29,14 +29,14 @@ function Versions(props) {
|
||||||
<h2 id="v2">Docusaurus v2</h2>
|
<h2 id="v2">Docusaurus v2</h2>
|
||||||
<p>
|
<p>
|
||||||
We now recommend using{' '}
|
We now recommend using{' '}
|
||||||
<a href="https://v2.docusaurus.io">Docusaurus v2</a>.
|
<a href="https://docusaurus.io">Docusaurus v2</a>.
|
||||||
</p>
|
</p>
|
||||||
<table className="versions">
|
<table className="versions">
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<th>2.x</th>
|
<th>2.x</th>
|
||||||
<td>
|
<td>
|
||||||
<a href="https://v2.docusaurus.io">Documentation</a>
|
<a href="https://docusaurus.io">Documentation</a>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
|
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
# CircleCI 2.0 Config File
|
|
||||||
# This config file will prevent tests from being run on the gh-pages branch.
|
|
||||||
version: 2
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
machine: true
|
|
||||||
branches:
|
|
||||||
ignore: gh-pages
|
|
||||||
steps:
|
|
||||||
-run: echo "Skipping tests on gh-pages branch"
|
|
||||||
|
|
@ -7,7 +7,7 @@ original_id: installation
|
||||||
|
|
||||||
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
||||||
|
|
||||||
> **Important Note:** If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use [Docusaurus 2](https://v2.docusaurus.io) instead.
|
> **Important Note:** If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use [Docusaurus 2](https://docusaurus.io) instead.
|
||||||
|
|
||||||
## Installing Docusaurus
|
## Installing Docusaurus
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ original_id: installation
|
||||||
|
|
||||||
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
||||||
|
|
||||||
> **Important Note:** If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use [Docusaurus 2](https://v2.docusaurus.io) instead.
|
> **Important Note:** If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use [Docusaurus 2](https://docusaurus.io) instead.
|
||||||
|
|
||||||
## Installing Docusaurus
|
## Installing Docusaurus
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ original_id: installation
|
||||||
|
|
||||||
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
|
||||||
|
|
||||||
> **Important Note:** we highly encourage you to use [Docusaurus 2](https://v2.docusaurus.io) instead.
|
> **Important Note:** we highly encourage you to use [Docusaurus 2](https://docusaurus.io) instead.
|
||||||
|
|
||||||
## Installing Docusaurus
|
## Installing Docusaurus
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ URL for site favicon. Example:
|
||||||
|
|
||||||
```js title="docusaurus.config.js"
|
```js title="docusaurus.config.js"
|
||||||
module.exports = {
|
module.exports = {
|
||||||
favicon: 'https://v2.docusaurus.io/favicon.ico',
|
favicon: 'https://docusaurus.io/favicon.ico',
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ It is mostly useful for plugin authors, that will be able to inspect more easily
|
||||||
|
|
||||||
If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily.
|
If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily.
|
||||||
|
|
||||||
If you don't have any sensitive information, you can keep it on in production [like we do](http://v2.docusaurus.io/__docusaurus/debug).
|
If you don't have any sensitive information, you can keep it on in production [like we do](http://docusaurus.io/__docusaurus/debug).
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -193,7 +193,7 @@ module.exports = {
|
||||||
alt: 'Site Logo',
|
alt: 'Site Logo',
|
||||||
src: 'img/logo.svg',
|
src: 'img/logo.svg',
|
||||||
srcDark: 'img/logo_dark.svg', // Default to `logo.src`.
|
srcDark: 'img/logo_dark.svg', // Default to `logo.src`.
|
||||||
href: 'https://v2.docusaurus.io/', // Default to `siteConfig.baseUrl`.
|
href: 'https://docusaurus.io/', // Default to `siteConfig.baseUrl`.
|
||||||
target: '_self', // By default, this value is calculated based on the `href` attribute (the external link will open in a new tab, all others in the current one).
|
target: '_self', // By default, this value is calculated based on the `href` attribute (the external link will open in a new tab, all others in the current one).
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ description: This is my first post on Docusaurus 2.
|
||||||
image: https://i.imgur.com/mErPwqL.png
|
image: https://i.imgur.com/mErPwqL.png
|
||||||
hide_table_of_contents: false
|
hide_table_of_contents: false
|
||||||
---
|
---
|
||||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
|
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ id: contributing
|
||||||
title: Contributing
|
title: Contributing
|
||||||
---
|
---
|
||||||
|
|
||||||
[Docusaurus 2](https://v2.docusaurus.io/) is currently under alpha development. We have [early adopters who already started using it](/showcase). We are now welcoming contributors to collaborate on the next Docusaurus.
|
[Docusaurus 2](https://docusaurus.io/) is currently under alpha development. We have [early adopters who already started using it](/showcase). We are now welcoming contributors to collaborate on the next Docusaurus.
|
||||||
|
|
||||||
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -51,7 +51,7 @@ It is possible to use:
|
||||||
|
|
||||||
## Home page docs {#home-page-docs}
|
## Home page docs {#home-page-docs}
|
||||||
|
|
||||||
If you want a document to be available at the root, and have a path like `https://v2.docusaurus.io/docs/`, you can use the slug frontmatter:
|
If you want a document to be available at the root, and have a path like `https://docusaurus.io/docs/`, you can use the slug frontmatter:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -290,8 +290,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting
|
||||||
|
|
||||||
The Docusaurus v2 website use this strategy:
|
The Docusaurus v2 website use this strategy:
|
||||||
|
|
||||||
- [https://v2.docusaurus.io](https://v2.docusaurus.io)
|
- [https://docusaurus.io](https://docusaurus.io)
|
||||||
- [https://v2.docusaurus.io/fr](https://v2.docusaurus.io/fr)
|
- [https://docusaurus.io/fr](https://docusaurus.io/fr)
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ title: Versioned sites
|
||||||
slug: /migration/versioned-sites
|
slug: /migration/versioned-sites
|
||||||
---
|
---
|
||||||
|
|
||||||
Read up https://v2.docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1's approach.
|
Read up https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1's approach.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ module.exports = {
|
||||||
organizationName: 'facebook',
|
organizationName: 'facebook',
|
||||||
projectName: 'docusaurus',
|
projectName: 'docusaurus',
|
||||||
baseUrl: '/blog-only/',
|
baseUrl: '/blog-only/',
|
||||||
url: 'https://v2.docusaurus.io',
|
url: 'https://docusaurus.io',
|
||||||
onBrokenLinks: 'throw',
|
onBrokenLinks: 'throw',
|
||||||
onBrokenMarkdownLinks: 'warn',
|
onBrokenMarkdownLinks: 'warn',
|
||||||
favicon: 'img/docusaurus.ico',
|
favicon: 'img/docusaurus.ico',
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ const isVersioningDisabled = !!process.env.DISABLE_VERSIONING || isI18nStaging;
|
||||||
projectName: 'docusaurus',
|
projectName: 'docusaurus',
|
||||||
baseUrl,
|
baseUrl,
|
||||||
baseUrlIssueBanner: true,
|
baseUrlIssueBanner: true,
|
||||||
url: 'https://v2.docusaurus.io',
|
url: 'https://docusaurus.io',
|
||||||
i18n: {
|
i18n: {
|
||||||
defaultLocale: 'en',
|
defaultLocale: 'en',
|
||||||
locales: isI18nStaging
|
locales: isI18nStaging
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,9 @@
|
||||||
# Server redirects for Netlify
|
# Server redirects for Netlify
|
||||||
|
|
||||||
|
# v2.docusaurus.io domain redirect after we put v2 on docusaurus.io
|
||||||
|
https://v2.docusaurus.io/* https://docusaurus.io/:splat 301!
|
||||||
|
|
||||||
|
|
||||||
# Redirect to fix blog post url typo on publish :'( can be cleaned up soon
|
# Redirect to fix blog post url typo on publish :'( can be cleaned up soon
|
||||||
/blog/2020/01/19/docusaurus-2020-recap /blog/2021/01/19/docusaurus-2020-recap
|
/blog/2020/01/19/docusaurus-2020-recap /blog/2021/01/19/docusaurus-2020-recap
|
||||||
/classic/blog/2020/01/19/docusaurus-2020-recap /classic/blog/2021/01/19/docusaurus-2020-recap
|
/classic/blog/2020/01/19/docusaurus-2020-recap /classic/blog/2021/01/19/docusaurus-2020-recap
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@
|
||||||
"related_applications": [
|
"related_applications": [
|
||||||
{
|
{
|
||||||
"platform": "webapp",
|
"platform": "webapp",
|
||||||
"url": "https://v2.docusaurus.io/manifest.json"
|
"url": "https://docusaurus.io/manifest.json"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"icons": [
|
"icons": [
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ URL for site favicon. Example:
|
||||||
|
|
||||||
```js title="docusaurus.config.js"
|
```js title="docusaurus.config.js"
|
||||||
module.exports = {
|
module.exports = {
|
||||||
favicon: 'https://v2.docusaurus.io/favicon.ico',
|
favicon: 'https://docusaurus.io/favicon.ico',
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ It is mostly useful for plugin authors, that will be able to inspect more easily
|
||||||
|
|
||||||
If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily.
|
If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily.
|
||||||
|
|
||||||
If you don't have any sensitive information, you can keep it on in production [like we do](http://v2.docusaurus.io/__docusaurus/debug).
|
If you don't have any sensitive information, you can keep it on in production [like we do](http://docusaurus.io/__docusaurus/debug).
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -193,7 +193,7 @@ module.exports = {
|
||||||
alt: 'Site Logo',
|
alt: 'Site Logo',
|
||||||
src: 'img/logo.svg',
|
src: 'img/logo.svg',
|
||||||
srcDark: 'img/logo_dark.svg', // Default to `logo.src`.
|
srcDark: 'img/logo_dark.svg', // Default to `logo.src`.
|
||||||
href: 'https://v2.docusaurus.io/', // Default to `siteConfig.baseUrl`.
|
href: 'https://docusaurus.io/', // Default to `siteConfig.baseUrl`.
|
||||||
target: '_self', // By default, this value is calculated based on the `href` attribute (the external link will open in a new tab, all others in the current one).
|
target: '_self', // By default, this value is calculated based on the `href` attribute (the external link will open in a new tab, all others in the current one).
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ description: This is my first post on Docusaurus 2.
|
||||||
image: https://i.imgur.com/mErPwqL.png
|
image: https://i.imgur.com/mErPwqL.png
|
||||||
hide_table_of_contents: false
|
hide_table_of_contents: false
|
||||||
---
|
---
|
||||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
|
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ id: contributing
|
||||||
title: Contributing
|
title: Contributing
|
||||||
---
|
---
|
||||||
|
|
||||||
[Docusaurus 2](https://v2.docusaurus.io/) is currently under alpha development. We have [early adopters who already started using it](/showcase). We are now welcoming contributors to collaborate on the next Docusaurus.
|
[Docusaurus 2](https://docusaurus.io/) is currently under alpha development. We have [early adopters who already started using it](/showcase). We are now welcoming contributors to collaborate on the next Docusaurus.
|
||||||
|
|
||||||
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -51,7 +51,7 @@ It is possible to use:
|
||||||
|
|
||||||
## Home page docs {#home-page-docs}
|
## Home page docs {#home-page-docs}
|
||||||
|
|
||||||
If you want a document to be available at the root, and have a path like `https://v2.docusaurus.io/docs/`, you can use the slug frontmatter:
|
If you want a document to be available at the root, and have a path like `https://docusaurus.io/docs/`, you can use the slug frontmatter:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -298,8 +298,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting
|
||||||
|
|
||||||
The Docusaurus v2 website use this strategy:
|
The Docusaurus v2 website use this strategy:
|
||||||
|
|
||||||
- [https://v2.docusaurus.io](https://v2.docusaurus.io)
|
- [https://docusaurus.io](https://docusaurus.io)
|
||||||
- [https://v2.docusaurus.io/fr](https://v2.docusaurus.io/fr)
|
- [https://docusaurus.io/fr](https://docusaurus.io/fr)
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ title: Versioned sites
|
||||||
slug: /migration/versioned-sites
|
slug: /migration/versioned-sites
|
||||||
---
|
---
|
||||||
|
|
||||||
Read up https://v2.docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1's approach.
|
Read up https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1's approach.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ URL for site favicon. Example:
|
||||||
|
|
||||||
```js title="docusaurus.config.js"
|
```js title="docusaurus.config.js"
|
||||||
module.exports = {
|
module.exports = {
|
||||||
favicon: 'https://v2.docusaurus.io/favicon.ico',
|
favicon: 'https://docusaurus.io/favicon.ico',
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ It is mostly useful for plugin authors, that will be able to inspect more easily
|
||||||
|
|
||||||
If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily.
|
If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily.
|
||||||
|
|
||||||
If you don't have any sensitive information, you can keep it on in production [like we do](http://v2.docusaurus.io/__docusaurus/debug).
|
If you don't have any sensitive information, you can keep it on in production [like we do](http://docusaurus.io/__docusaurus/debug).
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -193,7 +193,7 @@ module.exports = {
|
||||||
alt: 'Site Logo',
|
alt: 'Site Logo',
|
||||||
src: 'img/logo.svg',
|
src: 'img/logo.svg',
|
||||||
srcDark: 'img/logo_dark.svg', // Default to `logo.src`.
|
srcDark: 'img/logo_dark.svg', // Default to `logo.src`.
|
||||||
href: 'https://v2.docusaurus.io/', // Default to `siteConfig.baseUrl`.
|
href: 'https://docusaurus.io/', // Default to `siteConfig.baseUrl`.
|
||||||
target: '_self', // By default, this value is calculated based on the `href` attribute (the external link will open in a new tab, all others in the current one).
|
target: '_self', // By default, this value is calculated based on the `href` attribute (the external link will open in a new tab, all others in the current one).
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ description: This is my first post on Docusaurus 2.
|
||||||
image: https://i.imgur.com/mErPwqL.png
|
image: https://i.imgur.com/mErPwqL.png
|
||||||
hide_table_of_contents: false
|
hide_table_of_contents: false
|
||||||
---
|
---
|
||||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
|
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||||
|
|
||||||
<!--truncate-->
|
<!--truncate-->
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ id: contributing
|
||||||
title: Contributing
|
title: Contributing
|
||||||
---
|
---
|
||||||
|
|
||||||
[Docusaurus 2](https://v2.docusaurus.io/) is currently under alpha development. We have [early adopters who already started using it](/showcase). We are now welcoming contributors to collaborate on the next Docusaurus.
|
[Docusaurus 2](https://docusaurus.io/) is currently under alpha development. We have [early adopters who already started using it](/showcase). We are now welcoming contributors to collaborate on the next Docusaurus.
|
||||||
|
|
||||||
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Contributors and people new to open source alike will find the following guides especially useful:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -51,7 +51,7 @@ It is possible to use:
|
||||||
|
|
||||||
## Home page docs {#home-page-docs}
|
## Home page docs {#home-page-docs}
|
||||||
|
|
||||||
If you want a document to be available at the root, and have a path like `https://v2.docusaurus.io/docs/`, you can use the slug frontmatter:
|
If you want a document to be available at the root, and have a path like `https://docusaurus.io/docs/`, you can use the slug frontmatter:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -298,8 +298,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting
|
||||||
|
|
||||||
The Docusaurus v2 website use this strategy:
|
The Docusaurus v2 website use this strategy:
|
||||||
|
|
||||||
- [https://v2.docusaurus.io](https://v2.docusaurus.io)
|
- [https://docusaurus.io](https://docusaurus.io)
|
||||||
- [https://v2.docusaurus.io/fr](https://v2.docusaurus.io/fr)
|
- [https://docusaurus.io/fr](https://docusaurus.io/fr)
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ title: Versioned sites
|
||||||
slug: /migration/versioned-sites
|
slug: /migration/versioned-sites
|
||||||
---
|
---
|
||||||
|
|
||||||
Read up https://v2.docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1's approach.
|
Read up https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2#versioning first for problems in v1's approach.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue