mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-29 02:08:36 +02:00
chore: prepare v1-v2 domain switch (#4475)
* prepare v1-v2 domain switch * rename v1 changelog as CHANGELOG-1.x.md * switch v1/v2 changelogs
This commit is contained in:
Sébastien Lorber
GitHub
parent
f12e8b596d
commit
aaea26602b
27 changed files with 4355 additions and 4349 deletions
1355
CHANGELOG-1.x.md
Normal file
1355
CHANGELOG-1.x.md
Normal file
File diff suppressed because it is too large
Load diff
3062
CHANGELOG-2.x.md
3062
CHANGELOG-2.x.md
File diff suppressed because it is too large
Load diff
4165
CHANGELOG.md
4165
CHANGELOG.md
File diff suppressed because it is too large
Load diff
|
|
@ -1,6 +1,6 @@
|
|||
# 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://docusaurus.io/en/users.html), 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://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.
|
||||
|
||||
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:
|
||||
|
||||
- Simply start using Docusaurus. Go through the [Getting Started](https://docusaurus.io/docs/en/installation.html) 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://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).
|
||||
- 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.
|
||||
- Read through the [Docusaurus docs](https://docusaurus.io/docs/en/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://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.
|
||||
- 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.
|
||||
|
|
@ -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.
|
||||
|
||||
- `/docs` - The files in here are responsible for the "next" version at https://docusaurus.io/docs/en/next/installation.
|
||||
- `website-1.x/versioned_docs/version-X.Y.Z` - These are the docs for the X.Y.Z version at https://docusaurus.io/docs/en/X.Y.Z/installation.
|
||||
- `website/docs` - The files in here are responsible for the "next" version at https://v2.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.
|
||||
|
||||
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).
|
||||
|
||||
|
|
@ -57,11 +57,7 @@ When a change made on GitHub is approved, it will be checked by our continuous i
|
|||
|
||||
### Branch Organization
|
||||
|
||||
Docusaurus has two primary branches: `master` and `gh-pages`.
|
||||
|
||||
`master` is where our code lives and development takes place. We will do our best to keep `master` in good shape, with tests passing at all times. We will also do our best not to publish updated `npm` packages that will break sites. But in order to move fast, we may make changes that could break existing sites. We will do our best to communicate these changes and version appropriately so you can lock into a specific Docusaurus version if need be.
|
||||
|
||||
`gh-pages` contains the [Docusaurus documentation](https://docusaurus.io). This branch is pushed to by CI and not generally managed manually.
|
||||
Docusaurus has one primary branches `master` and we use feature branches with deploy previews to deliver new features with pull requests.
|
||||
|
||||
## Bugs
|
||||
|
||||
|
|
|
|||
22
README.md
22
README.md
|
|
@ -21,29 +21,39 @@
|
|||
|
||||
> **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.**
|
||||
|
||||
> Docusaurus v1 doc is available at [v1.docusaurus.io](https://v1.docusaurus.io)
|
||||
|
||||
## Introduction
|
||||
|
||||
Docusaurus is a project for building, deploying, and maintaining open source project websites easily.
|
||||
|
||||
Use **[new.docusaurus.io](https://new.docusaurus.io)** to test Docusaurus immediately in CodeSandbox.
|
||||
**Tip**: use **[new.docusaurus.io](https://new.docusaurus.io)** to test Docusaurus immediately in CodeSandbox.
|
||||
|
||||
- **Simple to Start**
|
||||
|
||||
> Docusaurus is built in a way so that it can [get running](https://docusaurus.io/docs/en/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://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.
|
||||
|
||||
- **Localizable**
|
||||
|
||||
> Docusaurus ships with [localization support](https://docusaurus.io/docs/en/translation/) via CrowdIn. Empower and grow your international community by translating your documentation.
|
||||
> Docusaurus ships with [localization support](https://v2.docusaurus.io/docs/i18n/introduction) via CrowdIn. Empower and grow your international community by translating your documentation.
|
||||
|
||||
- **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://docusaurus.io/docs/en/adding-blog/), and additional support pages, it is also [customizable](https://docusaurus.io/docs/en/custom-pages/) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/en/api-pages/).
|
||||
> 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).
|
||||
|
||||
## Installation
|
||||
|
||||
Docusaurus is available as the [`docusaurus` package](https://www.npmjs.com/package/docusaurus) on [npm](https://www.npmjs.com).
|
||||
Use the initialization cli to create your site:
|
||||
|
||||
We have also released the [`docusaurus-init` package](https://www.npmjs.com/package/docusaurus-init) to make [getting started](https://docusaurus.io/docs/en/installation/) with Docusaurus even easier.
|
||||
```bash
|
||||
npx @docusaurus/init@latest init [name] [template]
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npx @docusaurus/init@latest init my-website classic
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ Generate the changelog with:
|
|||
GITHUB_AUTH=<Your GitHub auth token> yarn changelog
|
||||
```
|
||||
|
||||
Copy the generated contents and paste them in `CHANGELOG-2.x.md`.
|
||||
Copy the generated contents and paste them in `CHANGELOG.md`.
|
||||
|
||||
**Note**: sometimes `lerna-changelog` gives an empty changelog ([bug report](https://github.com/lerna/lerna-changelog/issues/354)).
|
||||
|
||||
|
|
@ -261,7 +261,7 @@ Suppose we are at `v1.14.5`, and want to release `v1.14.6`:
|
|||
- Be on master (up-to-date): `git co master && git pull`
|
||||
- Create a new branch: `git co -b slorber/release-1.14.6`
|
||||
- Get the changelog from last release: `git fetch --tags && GITHUB_AUTH=<myToken> yarn changelog --from=v1.14.5`
|
||||
- Update [CHANGELOG.md](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md), but remove the v2-related items manually.
|
||||
- Update [CHANGELOG-1.x.md](https://github.com/facebook/docusaurus/blob/master/CHANGELOG-1.x.md), but remove the v2-related items manually.
|
||||
- Run `yarn install`
|
||||
- Version the docs: `yarn workspace docusaurus-1-website docusaurus-version 1.14.6`
|
||||
- Test the v1 website locally: `yarn start:v1` + `yarn build:v1`
|
||||
|
|
@ -294,7 +294,7 @@ Finish the release:
|
|||
### Historical v1 release process
|
||||
|
||||
1. Bump version number in [`package.json`](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/package.json).
|
||||
1. Update the [changelog](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md), including at the reference links at the bottom.
|
||||
1. Update the [CHANGELOG-1.x.md](https://github.com/facebook/docusaurus/blob/master/CHANGELOG-1.x.md), including at the reference links at the bottom.
|
||||
1. Do this always, but particularly important if there were any `package.json` changes in this release:
|
||||
1. If there is no `node_modules` directory in you local Docusaurus version, run `yarn install` and `npm install`.
|
||||
1. Run `yarn upgrade` to update `yarn.lock` and `npm update` to update `package-lock.json`.
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ class Versioning {
|
|||
console.error(
|
||||
`${chalk.yellow('No versions.js file found!')}` +
|
||||
`\nYou should create your versions.js file in pages/en directory.` +
|
||||
`\nPlease refer to https://docusaurus.io/docs/en/versioning.html.`,
|
||||
`\nPlease refer to https://v1.docusaurus.io/docs/en/versioning.html.`,
|
||||
);
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -21,9 +21,9 @@ We created [Docusaurus](https://docusaurus.io) for the following reasons:
|
|||
|
||||
<!--truncate-->
|
||||
|
||||
Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. At its core, all a user has to provide are documentation files written in markdown, customization of a provided home page written in React, and a few configuration modifications. Docusaurus handles the rest by providing default styles, site formatting, and simple document navigation. Getting started is easy, as users can [install](https://docusaurus.io/docs/en/installation.html) it using `npm` or `yarn` via a simple initialization script that [creates a working example website out of the box](https://docusaurus.io/docs/en/site-preparation.html).
|
||||
Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. At its core, all a user has to provide are documentation files written in markdown, customization of a provided home page written in React, and a few configuration modifications. Docusaurus handles the rest by providing default styles, site formatting, and simple document navigation. Getting started is easy, as users can [install](https://v1.docusaurus.io/docs/en/installation.html) it using `npm` or `yarn` via a simple initialization script that [creates a working example website out of the box](https://v1.docusaurus.io/docs/en/site-preparation.html).
|
||||
|
||||
Docusaurus also provides core website and documentation features out-of-the-box including [blog support](https://docusaurus.io/docs/en/blog.html), [internationalization](https://docusaurus.io/docs/en/translation.html), [search](https://docusaurus.io/docs/en/search.html), and [versioning](https://docusaurus.io/docs/en/versioning.html). While some projects may not require any of these features, enabling them is generally a matter of updating configuration options instead of having to add the infrastructure from the ground up. As more features get added to Docusaurus, users just can easily update to the latest version. This can be done by simply running npm or yarn update and updating configuration options. Users or teams will no longer need to manually rework their entire website infrastructure each time a new feature gets added.
|
||||
Docusaurus also provides core website and documentation features out-of-the-box including [blog support](https://v1.docusaurus.io/docs/en/blog.html), [internationalization](https://v1.docusaurus.io/docs/en/translation.html), [search](https://v1.docusaurus.io/docs/en/search.html), and [versioning](https://v1.docusaurus.io/docs/en/versioning.html). While some projects may not require any of these features, enabling them is generally a matter of updating configuration options instead of having to add the infrastructure from the ground up. As more features get added to Docusaurus, users just can easily update to the latest version. This can be done by simply running npm or yarn update and updating configuration options. Users or teams will no longer need to manually rework their entire website infrastructure each time a new feature gets added.
|
||||
|
||||
## The Birth of docusaurus
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ At Facebook, Docusaurus allows us to quickly get different projects up and runni
|
|||
|
||||
|
||||
|
||||
At its core, we wanted sites running Docusaurus to be simple to use. With one [installation](https://docusaurus.io/docs/en/installation.html) command and some simple [configuration](https://docusaurus.io/docs/en/site-preparation.html), you can actually have a default running website.
|
||||
At its core, we wanted sites running Docusaurus to be simple to use. With one [installation](https://v1.docusaurus.io/docs/en/installation.html) command and some simple [configuration](https://v1.docusaurus.io/docs/en/site-preparation.html), you can actually have a default running website.
|
||||
|
||||
When you run `docusaurus-init`, you will see a structure similar to:
|
||||
|
||||
|
|
@ -71,7 +71,7 @@ root-of-repo
|
|||
│ └── static
|
||||
```
|
||||
|
||||
With the exception of node_modules and package.json, all the directories and files you see are where you customize and add content to your Docusaurus-based website. The docs folder is where you add your markdown that represents your documentation; the blog folder is where you add your markdown for your [blog posts](https://docusaurus.io/docs/en/blog.html); `siteConfig.js` is where you make most of the [customizations](https://docusaurus.io/docs/en/site-config.html) for your site; `sidebars.json` is where you maintain the layout and content of the [sidebar](https://docusaurus.io/docs/en/navigation.html) for your documentation; the `pages` folder is where you add [custom](https://docusaurus.io/docs/en/custom-pages.html) pages for your site; the `static` folder is where all of your static assets go (e.g., CSS stylesheets and images); and the `core` folder is where you can customize core components of the site, in this case the footer.
|
||||
With the exception of node_modules and package.json, all the directories and files you see are where you customize and add content to your Docusaurus-based website. The docs folder is where you add your markdown that represents your documentation; the blog folder is where you add your markdown for your [blog posts](https://v1.docusaurus.io/docs/en/blog.html); `siteConfig.js` is where you make most of the [customizations](https://v1.docusaurus.io/docs/en/site-config.html) for your site; `sidebars.json` is where you maintain the layout and content of the [sidebar](https://v1.docusaurus.io/docs/en/navigation.html) for your documentation; the `pages` folder is where you add [custom](https://v1.docusaurus.io/docs/en/custom-pages.html) pages for your site; the `static` folder is where all of your static assets go (e.g., CSS stylesheets and images); and the `core` folder is where you can customize core components of the site, in this case the footer.
|
||||
|
||||
## How does Docusaurus work?
|
||||
|
||||
|
|
@ -139,7 +139,7 @@ We welcome your [contributions](https://github.com/facebook/docusaurus/blob/mast
|
|||
|
||||
Docusaurus wouldn't exist without the work of the rest of the core Docusaurus team: [Eric Nakagawa](http://twitter.com/ericnakagawa), [Hector Ramos](https://twitter.com/hectorramos), [Eric Vicenti](https://twitter.com/EricVicenti) and [Frank Li](https://github.com/deltice) — a former intern at Facebook who implemented the core technology and features.
|
||||
|
||||
Special thanks also goes out to our earliest [adopters](https://docusaurus.io/en/users.html) of Docusaurus:
|
||||
Special thanks also goes out to our earliest [adopters](https://v1.docusaurus.io/en/users.html) of Docusaurus:
|
||||
|
||||
- [BuckleScript](https://bucklescript.github.io/)
|
||||
- [FastText](https://fasttext.cc)
|
||||
|
|
@ -154,7 +154,7 @@ Without their dedication to creating or migrating their websites over to the pla
|
|||
|
||||
## Resources
|
||||
|
||||
- [Read our documentation](https://docusaurus.io)
|
||||
- [Read our documentation](https://v1.docusaurus.io)
|
||||
- [Follow our Twitter feed](https://twitter.com/docusaurus)
|
||||
- [Follow us on GitHub](https://github.com/facebook/docusaurus)
|
||||
- [About Slash, the Docusaurus mascot](https://docusaurus.io/about-slash.html)
|
||||
- [About Slash, the Docusaurus mascot](https://v1.docusaurus.io/about-slash.html)
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ Here's an overview of the steps taken to convert to a website. I'll discuss some
|
|||
**Initial website setup:**
|
||||
|
||||
1. Forked the [Profilo project](https://github.com/facebookincubator/profilo/) on GitHub and created a local clone of the fork to set up the website.
|
||||
1. Created the initial Docusaurus website using the [installation instructions](https://docusaurus.io/docs/en/installation.html).
|
||||
1. Created the initial Docusaurus website using the [installation instructions](https://v1.docusaurus.io/docs/en/installation.html).
|
||||
1. Deleted the `docs-examples-from-docusaurus` and `website/blog-examples-from-docusaurus` folders as these would not be needed. Profilo had existing docs we could use and there was no need for blogs at this time.
|
||||
|
||||
**Content creation:**
|
||||
|
|
@ -79,7 +79,7 @@ Here's an overview of the steps taken to convert to a website. I'll discuss some
|
|||
CURRENT_BRANCH=master \
|
||||
yarn run publish-gh-pages
|
||||
|
||||
1. Configured CircleCI using the [provided Docusaurus instructions](https://docusaurus.io/docs/en/publishing.html#automating-deployments-using-continuous-integration). There were 2 PRs for this, [the first](https://github.com/facebookincubator/profilo/pull/8)for the initial config and [the second](https://github.com/facebookincubator/profilo/pull/12) to make sure CircleCI only triggered for changes in the master branch (thanks Joel Marcey!).
|
||||
1. Configured CircleCI using the [provided Docusaurus instructions](https://v1.docusaurus.io/docs/en/publishing.html#automating-deployments-using-continuous-integration). There were 2 PRs for this, [the first](https://github.com/facebookincubator/profilo/pull/8)for the initial config and [the second](https://github.com/facebookincubator/profilo/pull/12) to make sure CircleCI only triggered for changes in the master branch (thanks Joel Marcey!).
|
||||
|
||||
The final website was published on https://facebookincubator.github.io/profilo/. It had taken 1.5 hours to get to the initial PR stage and another half an hour or so to respond to review feedback and publish the website.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ authorTwitter: endiliey
|
|||
tags: [new, adoption]
|
||||
---
|
||||
|
||||
Docusaurus was [officially announced](https://docusaurus.io/blog/2017/12/14/introducing-docusaurus) over nine months ago as a way to easily build open source documentation websites. Since then, it has amassed over 8,600 GitHub Stars, and is used by many popular open source projects such as [React Native](https://facebook.github.io/react-native/), [Babel](https://babeljs.io/), [Jest](https://jestjs.io/), [Reason](https://reasonml.github.io/) and [Prettier](https://prettier.io/).
|
||||
Docusaurus was [officially announced](https://v1.docusaurus.io/blog/2017/12/14/introducing-docusaurus) over nine months ago as a way to easily build open source documentation websites. Since then, it has amassed over 8,600 GitHub Stars, and is used by many popular open source projects such as [React Native](https://facebook.github.io/react-native/), [Babel](https://babeljs.io/), [Jest](https://jestjs.io/), [Reason](https://reasonml.github.io/) and [Prettier](https://prettier.io/).
|
||||
|
||||
There is a saying that the very best software is constantly evolving, and the very worst is not. In case you are not aware, we have been planning and working on the next version of Docusaurus 🎉.
|
||||
|
||||
|
|
@ -121,7 +121,7 @@ For now, the actual Docusaurus 2 work is still hosted in a private repository. I
|
|||
|
||||
## Final Thoughts
|
||||
|
||||
Docusaurus has had a large impact on the open source community as seen from the [many popular projects](https://docusaurus.io/en/users) which use Docusaurus for documentation. In order to move faster in the future, we are taking the opportunity to fix some core problems with Docusaurus 1 and striving to make Docusaurus better for everyone. In fact, it is safe to say that Docusaurus 2 is not just a plan any longer; the work on it has started and, hopefully, we will be able to see it materialize in the near future.
|
||||
Docusaurus has had a large impact on the open source community as seen from the [many popular projects](https://v1.docusaurus.io/en/users) which use Docusaurus for documentation. In order to move faster in the future, we are taking the opportunity to fix some core problems with Docusaurus 1 and striving to make Docusaurus better for everyone. In fact, it is safe to say that Docusaurus 2 is not just a plan any longer; the work on it has started and, hopefully, we will be able to see it materialize in the near future.
|
||||
|
||||
Docusaurus' mission has always been to make it really easy for you to get a website with documentation up and running out of the box. That mission does not change with Docusaurus 2.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,11 +11,11 @@ tags: [birth]
|
|||
|
||||
|
||||
|
||||
Docusaurus [went live](https://docusaurus.io/blog/2017/12/14/introducing-docusaurus) on December 14, 2017. At the time, we had [8 early adopters](https://docusaurus.io/blog/2017/12/14/introducing-docusaurus#acknowledgements).
|
||||
Docusaurus [went live](https://v1.docusaurus.io/blog/2017/12/14/introducing-docusaurus) on December 14, 2017. At the time, we had [8 early adopters](https://v1.docusaurus.io/blog/2017/12/14/introducing-docusaurus#acknowledgements).
|
||||
|
||||
<!--truncate-->
|
||||
|
||||
We now have nearly [60 known users of Docusaurus](https://docusaurus.io/en/users), and probably more that we don't know about. We have [9K GitHub stars](https://github.com/facebook/docusaurus) and an active community, particularly [Yangshun Tay](https://twitter.com/yangshunz) and [Endilie Yacop Sucipto](https://twitter.com/endiliey), both of whom are the lead maintainers helping keep this project [moving forward](https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2).
|
||||
We now have nearly [60 known users of Docusaurus](https://v1.docusaurus.io/en/users), and probably more that we don't know about. We have [9K GitHub stars](https://github.com/facebook/docusaurus) and an active community, particularly [Yangshun Tay](https://twitter.com/yangshunz) and [Endilie Yacop Sucipto](https://twitter.com/endiliey), both of whom are the lead maintainers helping keep this project [moving forward](https://docusaurus.io/blog/2018/09/11/Towards-Docusaurus-2).
|
||||
|
||||
Thank you to everyone for your support and use of this project! I am super proud of how far this project has come in just a year.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ title: Navigation and Sidebars
|
|||
|
||||
## Referencing Site Documents
|
||||
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://v1.docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
|
||||
For example, if you are in `doc2.md` and you want to reference `doc1.md`:
|
||||
|
||||
|
|
|
|||
|
|
@ -66,8 +66,8 @@ npm run version 1.0.1
|
|||
|
||||
Version 1.0.0 remains available as a past version. You can view it by adding `1.0.0` to the URL, http://localhost:3000/docusaurus-tutorial/docs/1.0.0/doc1. Also, a link to version 1.0.0 appears on the versions page.
|
||||
|
||||
Go ahead and [publish](https://docusaurus.io/docs/en/next/tutorial-publish-site) your versioned site with the `publish-gh-pages` script!
|
||||
Go ahead and [publish](https://v1.docusaurus.io/docs/en/next/tutorial-publish-site) your versioned site with the `publish-gh-pages` script!
|
||||
|
||||
## Wrap Up
|
||||
|
||||
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the [Guides](https://docusaurus.io/docs/en/next/versioning) section for more.
|
||||
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the [Guides](https://v1.docusaurus.io/docs/en/next/versioning) section for more.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ original_id: navigation
|
|||
|
||||
## Referencing Site Documents
|
||||
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://v1.docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
|
||||
For example, if you are in `doc2.md` and you want to reference `doc1.md`:
|
||||
|
||||
|
|
|
|||
|
|
@ -67,8 +67,8 @@ npm run version 1.0.1
|
|||
|
||||
Version 1.0.0 remains available as a past version. You can view it by adding `1.0.0` to the URL, http://localhost:3000/docusaurus-tutorial/docs/1.0.0/doc1. Also, a link to version 1.0.0 appears on the versions page.
|
||||
|
||||
Go ahead and [publish](https://docusaurus.io/docs/en/next/tutorial-publish-site) your versioned site with the `publish-gh-pages` script!
|
||||
Go ahead and [publish](https://v1.docusaurus.io/docs/en/next/tutorial-publish-site) your versioned site with the `publish-gh-pages` script!
|
||||
|
||||
## Wrap Up
|
||||
|
||||
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the [Guides](https://docusaurus.io/docs/en/next/versioning) section for more.
|
||||
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the [Guides](https://v1.docusaurus.io/docs/en/next/versioning) section for more.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ original_id: navigation
|
|||
|
||||
## Referencing Site Documents
|
||||
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://v1.docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
|
||||
For example, if you are in `doc2.md` and you want to reference `doc1.md`:
|
||||
|
||||
|
|
|
|||
|
|
@ -67,8 +67,8 @@ npm run version 1.0.1
|
|||
|
||||
Version 1.0.0 remains available as a past version. You can view it by adding `1.0.0` to the URL, http://localhost:3000/docusaurus-tutorial/docs/1.0.0/doc1. Also, a link to version 1.0.0 appears on the versions page.
|
||||
|
||||
Go ahead and [publish](https://docusaurus.io/docs/en/next/tutorial-publish-site) your versioned site with the `publish-gh-pages` script!
|
||||
Go ahead and [publish](https://v1.docusaurus.io/docs/en/next/tutorial-publish-site) your versioned site with the `publish-gh-pages` script!
|
||||
|
||||
## Wrap Up
|
||||
|
||||
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the [Guides](https://docusaurus.io/docs/en/next/versioning) section for more.
|
||||
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the [Guides](https://v1.docusaurus.io/docs/en/next/versioning) section for more.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ original_id: navigation
|
|||
|
||||
## Referencing Site Documents
|
||||
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
If you want to reference another document in your `docs` directory (or the location you set via the [optional `customDocsPath`](https://v1.docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.
|
||||
|
||||
For example, if you are in `doc2.md` and you want to reference `doc1.md`:
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Use **[new.docusaurus.io](https://new.docusaurus.io)** to test Docusaurus immedi
|
|||
|
||||
:::
|
||||
|
||||
**Use [Docusaurus v1](https://docusaurus.io/) if:**
|
||||
**Use [Docusaurus v1](https://v1.docusaurus.io/) if:**
|
||||
|
||||
- :x: You don't want a single-page application (SPA)
|
||||
- :x: You prefer stability over modernity
|
||||
|
|
|
|||
|
|
@ -420,10 +420,10 @@ In v1, all pages were available with or without the `.html` extension.
|
|||
|
||||
For example, these 2 pages exist:
|
||||
|
||||
- [https://docusaurus.io/docs/en/installation](https://docusaurus.io/docs/en/installation)
|
||||
- [https://docusaurus.io/docs/en/installation.html](https://docusaurus.io/docs/en/installation.html)
|
||||
- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation)
|
||||
- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html)
|
||||
|
||||
If [`cleanUrl`](https://docusaurus.io/docs/en/site-config#cleanurl-boolean) was:
|
||||
If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was:
|
||||
|
||||
- `true`: links would target `/installation`
|
||||
- `false`: links would target `/installation.html`
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ Example `versioned_sidebars/version-1.0.0-sidebars.json`:
|
|||
|
||||
## Populate your `versioned_sidebars` and `versioned_docs` {#populate-your-versioned_sidebars-and-versioned_docs}
|
||||
|
||||
In v2, we use snapshot approach for documentation versioning. **Every versioned docs does not depends on other version**. It is possible to have `foo.md` in `version-1.0.0` but it doesn't exist in `version-1.2.0`. This is not possible in previous version due to Docusaurus v1 fallback functionality (https://docusaurus.io/docs/en/versioning#fallback-functionality).
|
||||
In v2, we use snapshot approach for documentation versioning. **Every versioned docs does not depends on other version**. It is possible to have `foo.md` in `version-1.0.0` but it doesn't exist in `version-1.2.0`. This is not possible in previous version due to Docusaurus v1 fallback functionality (https://v1.docusaurus.io/docs/en/versioning#fallback-functionality).
|
||||
|
||||
For example, if your `versions.json` looks like this in v1
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Use **[new.docusaurus.io](https://new.docusaurus.io)** to test Docusaurus immedi
|
|||
|
||||
:::
|
||||
|
||||
**Use [Docusaurus v1](https://docusaurus.io/) if:**
|
||||
**Use [Docusaurus v1](https://v1.docusaurus.io/) if:**
|
||||
|
||||
- :x: You don't want a single-page application (SPA)
|
||||
- :x: You prefer stability over modernity
|
||||
|
|
|
|||
|
|
@ -420,10 +420,10 @@ In v1, all pages were available with or without the `.html` extension.
|
|||
|
||||
For example, these 2 pages exist:
|
||||
|
||||
- [https://docusaurus.io/docs/en/installation](https://docusaurus.io/docs/en/installation)
|
||||
- [https://docusaurus.io/docs/en/installation.html](https://docusaurus.io/docs/en/installation.html)
|
||||
- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation)
|
||||
- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html)
|
||||
|
||||
If [`cleanUrl`](https://docusaurus.io/docs/en/site-config#cleanurl-boolean) was:
|
||||
If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was:
|
||||
|
||||
- `true`: links would target `/installation`
|
||||
- `false`: links would target `/installation.html`
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ Example `versioned_sidebars/version-1.0.0-sidebars.json`:
|
|||
|
||||
## Populate your `versioned_sidebars` and `versioned_docs` {#populate-your-versioned_sidebars-and-versioned_docs}
|
||||
|
||||
In v2, we use snapshot approach for documentation versioning. **Every versioned docs does not depends on other version**. It is possible to have `foo.md` in `version-1.0.0` but it doesn't exist in `version-1.2.0`. This is not possible in previous version due to Docusaurus v1 fallback functionality (https://docusaurus.io/docs/en/versioning#fallback-functionality).
|
||||
In v2, we use snapshot approach for documentation versioning. **Every versioned docs does not depends on other version**. It is possible to have `foo.md` in `version-1.0.0` but it doesn't exist in `version-1.2.0`. This is not possible in previous version due to Docusaurus v1 fallback functionality (https://v1.docusaurus.io/docs/en/versioning#fallback-functionality).
|
||||
|
||||
For example, if your `versions.json` looks like this in v1
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Use **[new.docusaurus.io](https://new.docusaurus.io)** to test Docusaurus immedi
|
|||
|
||||
:::
|
||||
|
||||
**Use [Docusaurus v1](https://docusaurus.io/) if:**
|
||||
**Use [Docusaurus v1](https://v1.docusaurus.io/) if:**
|
||||
|
||||
- :x: You don't want a single-page application (SPA)
|
||||
- :x: You prefer stability over modernity
|
||||
|
|
|
|||
|
|
@ -420,10 +420,10 @@ In v1, all pages were available with or without the `.html` extension.
|
|||
|
||||
For example, these 2 pages exist:
|
||||
|
||||
- [https://docusaurus.io/docs/en/installation](https://docusaurus.io/docs/en/installation)
|
||||
- [https://docusaurus.io/docs/en/installation.html](https://docusaurus.io/docs/en/installation.html)
|
||||
- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation)
|
||||
- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html)
|
||||
|
||||
If [`cleanUrl`](https://docusaurus.io/docs/en/site-config#cleanurl-boolean) was:
|
||||
If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was:
|
||||
|
||||
- `true`: links would target `/installation`
|
||||
- `false`: links would target `/installation.html`
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ Example `versioned_sidebars/version-1.0.0-sidebars.json`:
|
|||
|
||||
## Populate your `versioned_sidebars` and `versioned_docs` {#populate-your-versioned_sidebars-and-versioned_docs}
|
||||
|
||||
In v2, we use snapshot approach for documentation versioning. **Every versioned docs does not depends on other version**. It is possible to have `foo.md` in `version-1.0.0` but it doesn't exist in `version-1.2.0`. This is not possible in previous version due to Docusaurus v1 fallback functionality (https://docusaurus.io/docs/en/versioning#fallback-functionality).
|
||||
In v2, we use snapshot approach for documentation versioning. **Every versioned docs does not depends on other version**. It is possible to have `foo.md` in `version-1.0.0` but it doesn't exist in `version-1.2.0`. This is not possible in previous version due to Docusaurus v1 fallback functionality (https://v1.docusaurus.io/docs/en/versioning#fallback-functionality).
|
||||
|
||||
For example, if your `versions.json` looks like this in v1
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue