Commit graph

44 commits

Author SHA1 Message Date
Ayush das
632b21bcf6
docs(v2): update installation docs (#5073)
* docs: update installation docs to 2.0.0beta.2

* Update website/docs/installation.md

* Update website/docs/installation.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-06-29 10:20:41 +02:00
Sébastien Lorber
59f78f9084
docs(v2): document canary releases (#4987) 2021-06-16 16:11:41 +02:00
Sébastien Lorber
85cf1be79a
docs(v2): Docusaurus 2 beta blog post (#4756)
* draft

* draft

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* update draft

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md

* update draft post

* link to testimonials collection

* remove alpha mention in doc

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

* Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md

Co-authored-by: Joel Marcey <joelm@fb.com>

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Joel Marcey <joelm@fb.com>
2021-05-12 16:08:07 +02:00
Sébastien Lorber
fe6492aa87
docs(v2): Improve intro doc (#4770)
* Intro documentation refactoring

* useless images

* improve the intro doc
2021-05-12 14:40:35 +02:00
Tommy
1cbd80b8cd
docs(v2): Fix typo in installation.md(#4643) 2021-04-20 15:27:09 +02:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Alexey Pyltsyn
1c7d423e0c
docs(v2): various improvements (#4369)
* docs(v2): various improvements

* Update blog.md
2021-03-09 14:59:32 +01:00
Alexey Pyltsyn
f13448d5e1
chore(v2): upgrade dependencies + require Node 12 (#4223)
* chore(v2): upgrade dependencies

* Set minimum Node.js version to 12.13

* Fix test

* Upgrade copy-text-to-clipboard

* Bump Node versions

* Update .nvmrc

* mark cacheTime as forbidded field

* Downgrade jest to v25.2.7

* Increase Node version for Windows CI

* Test fix

* Attempt to fix Windows CI

* Downgrade execa

* fix async test errors

* Upgrade execa

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-18 15:12:42 +01:00
Nahiyan Kamal
385d8b6315
docs(v2): typo fixing double colon (#4173) 2021-02-04 12:23:20 +01:00
Jessica Lin
4d3573dfcb
docs(v2): update check yarn installation command (#4170)
As listed `yarn version` doesn't work. According to [Yarn docs](https://classic.yarnpkg.com/en/docs/install#mac-stable), the command to check install should be `yarn --version`.
2021-02-04 01:15:52 +03:00
Nahiyan Kamal
0c80fa824c
fix(v2): remove unnecessary brace from installation doc (#4127) 2021-01-31 22:39:55 +03:00
sammychinedu2ky
b93d95b9e0
docs(v2): Add codesandbox integration (#4062) 2021-01-19 16:00:07 +01:00
Kumar Aditya
0bb5e547b1
feat(v2): skip dependency install on docusaurus init (#3986)
* fix: #3450

Signed-off-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>

* test: fix failing test

Signed-off-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2021-01-04 16:17:06 +01:00
Sébastien Lorber
d99d53a236
docs(v2): Reorganize/split the guides doc sections (#3975)
* docs reorg

* refactor docs/markdown features section

* fix broken links after docs refactor
2020-12-30 17:03:25 +01:00
borool
dd8f3257a8
docs(v2): typo (#3856)
* Typo

That was written 2 times, I removed one "that"

* Update installation.md

* Update installation.md

* Update installation.md

* Update installation.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-12-10 17:13:23 +01:00
Sébastien Lorber
9e314bcb11
docs(v2): fix Docusaurus init issue when not using @latest (#3803) 2020-11-23 20:24:11 +03:00
Sébastien Lorber
4fbece2383
docs(v2): remove @next tags + minor docs changes (#3783) 2020-11-19 12:48:18 +01:00
camiluc
7d4510b686
docs(v2): rename zeit to vercel (#3781) 2020-11-19 12:43:38 +01:00
Sébastien Lorber
c22c132fe0
docs(v2): deployment should use mdx extension (#3699)
* deployment: make it a mdx component because it contains <Tabs>

* fix deployment md links

* typo

* fix more links
2020-11-05 18:22:18 +01:00
Fanny
8c05aa8e94
feat(v2): bootstrap theme, preset, template, CI previews (#2981)
* fix(v2): doc sidebar

* chore(v2): prettier

* fix(v2): docs navbar path

* fix(v2): fix error about activepath

* chore(v2): prettier

* feat(v2): change active color

* feat(v2): Add bootstrap doc

* docs(v2): Update preset

* doc(v2): finish bootstrap documentation

* chore(v2): run lint

* doc(v2): update hook

* fix theme bootstrap layout (far from perfect)

* Try to fix bootstrap theme and deploy it!

* fix netlify error

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2020-08-17 20:18:37 +02:00
Teik Jun
300aecb8bc
feat(v2): warn user when there are conflicting routes (#3083)
* feat(v2): add warning for path override

* feat(v2): check all routes recursively

* docs(v2): add docs for conflicting routes

* style(v2): improve comments in code

* refactor(v2): remove unused lifecycle method from docs plugin

* Revert "refactor(v2): remove unused lifecycle method from docs plugin"

This reverts commit 8b2caaa091.

* feat(v2): add option for changing duplicate path behavior

* feat(v2): decouple logging from logic and detect duplicate routes in one pass

* test(v2): fix failing tests

* test(v2): add tests for duplicateRoutes

* test(v2): add test for handleDuplicateRoutes

* style(v2): add else statement

* docs(v2): modify documentation for duplicate routes

* docs(v2): move doc into guides folder

* fix(v2): fix broken links

* docs(v2): move docs for docusaurus config into api folder

* style(v2): add comments

* refactor(v2): extract getFinalRoutes

* refactor(v2): scope getFinalRoutes to docusaurus package

* test(v2): remove obsolete snapshots

* docs(v2): remove some docs

* fix(v2): rerun github actions

* docs(v2): change slug of docs in api folder

* refactor(v2): extract out a reportMessage method

* refactor(v2): extract getAllFinalRoutes

* test(v2): replace snapshots with actual value

* style(v2): remove unnecessary comment and change type

* chore(v2): remove unused dependency

* style(v2): remove unused code

* Update packages/docusaurus/src/server/utils.ts

* Update website/docs/guides/creating-pages.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-07-31 21:14:49 +02:00
Paul Glezen
4278cebf67
docs(v2): fix typo in command on installation page (#2886)
* Fix installation.md typo

Checking the docusaurus version should be done with

```
npx docusaurus --version
```

not 

```
npm docusaurus --version
```

otherwise it prints the version of `npm` instead of `docusaurus`.

* docs: Fixed installation.md for checking version.

Specifying `npm` for the version will yield the version of NPM
instead of docusaurus itself.  Use `npx` for the docusaurus version.
2020-06-06 04:14:53 +03:00
Sam Zhou
33b60c6ba4
fix(v2): Consistently use 10.15.1 as the minimum required node version (#2819) 2020-05-27 23:18:48 +08:00
Alexey Pyltsyn
fc161b8455
docs(v2): various improvements (#2768) 2020-05-18 11:37:53 +08:00
Jay Lees
ad425b2652
docs(v2): remove duplicated package.json in installation directory structure (#2596) 2020-04-13 17:33:40 +08:00
Yangshun Tay
3dd83be988
docs(v2): proofread docs (#2527) 2020-04-04 14:05:59 +08:00
Yangshun Tay
8018a835e5
docs(v2): misc docs updates (#2500) 2020-04-02 12:29:39 +08:00
Favour Kelvin
dddf061f75
docs(v2):update alpha version to current version (#2397)
Co-authored-by: Favour Kelvin <favourkelvin17gmail.com>
2020-03-11 00:52:07 +08:00
Theodore Chu
baed4faa24
docs(v2): guide on upgrading Docusaurus within a project (#2338)
* Update installation.md

Add information on how to update/upgrade the version of Docusaurus

* Update installation.md

* Update installation.md

* Update installation.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-02-28 09:46:37 +08:00
Yangshun Tay
a38125a718
chore: drop support for node <10.9 (#2207)
* drop node <10.9 on 2020

* misc: add nvmrc

Co-authored-by: Endi <endiliey@gmail.com>
2020-01-12 13:24:11 +08:00
Yangshun Tay
19acc44d81
docs: promote Docusaurus 2 usage (#2126) 2019-12-15 17:49:25 +08:00
Yangshun Tay
55e676cb25
misc: add command to run prettier on docs (#2102)
* misc: add command to run prettier on docs

* Fix GH issue template

* Fix tests

* Add prettier-docs command to precommit
2019-12-07 21:56:30 -08:00
Alexey Pyltsyn
91ef5c67cf
docs(v2): make proper spelling of Stack Overflow (#2053) 2019-11-25 16:50:00 +03:00
Endi
421f862701 breaking(v2): required nodejs version >=8.9 -> >=8.10 so we can use es2017 (#2045) 2019-11-24 21:40:57 -08:00
Endi
c533adc4aa docs(v2): display yarn and npm command on website (#2037)
* docs(v2): display yarn and npm command on website

* more

* fix div cannot be descendant p
2019-11-23 18:32:26 -08:00
Alexey Pyltsyn
b8335fe925 docs(v2): fix typos (#1930) 2019-11-02 08:12:04 +08:00
Endi
a9f752cf23
docs(v2): update config docs (#1885) 2019-10-25 23:35:02 +07:00
Yangshun Tay
a684806a0f fix(v2): do not reveal environment file path (#1692)
* fix(v2): do not reveal environment file path

* changelog

* fix broken markdown linking
2019-07-23 13:12:21 +07:00
endiliey
ea19b35e90 docs(v2): better install docs 2019-07-14 17:58:25 +07:00
Yangshun Tay
c021367a18
docs(v2): proofread docs for alpha.20 (#1658)
* docs(v2): proofread docs for alpha.20

* docs(v2): update creating pages doc

* docs(v2): further updates to creating pages doc

* chore(v2): update CHANGELOG
2019-07-13 19:21:39 -07:00
Endi
d61cc01217
feat(v2): @docusaurus/init package (#1655)
* feat(v2): separate v2 docusaurus/init package

* nits

* docs

* rm unwanted

* readme
2019-07-14 01:06:23 +07:00
Wei Gao
d1418af5ba chore(v2): tweak installation doc (#1621)
- generated site to match what is described in the doc
- minor changes in the installation page
2019-06-23 10:32:10 -07:00
Endi
404983c32b docs(v2): install, create pages, docs, deploy (#1522)
* docs(v2): install, create pages, docs, deploy

* docs(v2): Docs review changes for installation, create pages, docs,
deploy

* docs(v2): more docs!
2019-05-29 01:08:06 -07:00
Yangshun Tay
5d6dc49bcd
docs(v2): add docs skeleton and structure (#1412)
* docs(v2): add docs skeleton and structure

* docs(v2): add on

* docs(v2): move motivation into contributing
2019-04-28 20:20:24 -07:00