Leedom
b842197ac6
docs: consistently use sidebars.js filename ( #7016 )
...
* modify sidebar.js to sidebars.js in installation.md
* modify sidebar.js to sidebars.js
Co-authored-by: leedom <leedom@jinlanzuan.com>
2022-03-27 09:55:12 +08:00
Joshua Chen
2648ec090e
docs: editorial fixes ( #6889 )
2022-03-10 13:43:22 +08:00
Joshua Chen
a70514205d
feat(create): new --package-manager option; interactive package manager selection ( #6750 )
2022-02-24 11:50:37 +01:00
Alexey Pyltsyn
26d223dbeb
feat(create): better detection of package manager preference ( #6679 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-23 16:22:40 +01:00
Joshua Chen
b16b394eb6
feat(create): allow specifying a git clone strategy ( #6610 )
...
* feat(create): allow specifying a git clone strategy
* Update index.ts
2022-02-10 11:15:06 +08:00
Joshua Chen
c1e3801ee7
fix(cli): allow passing a list of file names to write-heading-ids ( #6500 )
2022-01-29 12:21:15 +08:00
Joshua Chen
ddfd154ad6
docs: make upgrade guide always show the latest version ( #6336 )
2022-01-14 10:42:48 +08:00
Nayan Patel
52e097e2c1
docs: mention setup in monorepo ( #6297 )
...
* Add Monorepos
* elaborate
* elaborate
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-09 10:49:29 +08:00
Joshua Chen
73ee356949
docs: audit grammar issues ( #6203 )
...
* docs: audit grammar mistakes
* fix code block language
* revert change
* let's get another
2021-12-27 19:34:04 +08:00
Nayan Patel
7fcadd0c36
docs: make installation guide more beginner-friendly ( #6187 )
...
* Add support for beginners
* Add files via upload
* Update intro.md
* Update intro.md
* Update intro.md
* Update intro.md
* Update intro.md
* Edits
* Edits
* Last nits
* Edit
* Update installation.md
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-26 19:29:47 +08:00
Afshin Mehrabani
54d0755493
feat(create-docusaurus): allow using local folder as template ( #3458 )
...
* feat(docusaurus-init): search the local ./templates folder during doc init
* Add docs
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-15 12:37:22 +08:00
Sébastien Lorber
1ce6253cc1
chore: require Node 14 ( #5812 )
2021-10-28 17:11:25 +02:00
Sébastien Lorber
ca5d70d7fb
docs: use "npx create-docusaurus" for init ( #5797 )
2021-10-27 14:46:25 +02:00
Alexey Pyltsyn
647c8a2918
docs: fix npm init command with options ( #5712 )
...
* docs: fix npm init command with options
* Update test-release.sh
2021-10-15 16:31:15 +03:00
Sébastien Lorber
f6ec757aa0
feat: npm init docusaurus, yarn create docusaurus ( #5635 )
...
* initial create-docusaurus impl
* cleanup
* @docusaurus/init renamed to create-docusaurus
* 0.0.6
* update lockfile
* fix lint
* remove npm2yarn for "npm init" because npm2yarn doesn't convert it and yarn result fails to execute
* prettier
* add correct version
* prettier
* prettier
* prettier
* prettier
* fix annoying --config .prettierrc issue
2021-10-07 16:06:42 +02:00
Sébastien Lorber
a0c2c52829
chore: remove unused Bootstrap theme ( #5634 )
...
* remove package
* remove bootstrap from doc
* remove bootstrap init template + examples
* remove bootstrap preset
* remaining bootstrap refs
* update lockfile
2021-10-01 17:44:34 +02:00
Joshua Chen
493225a3c6
feat(plugin-blog): multi-authors support + authors.yml global configuration ( #5396 )
...
* Complete function
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* A lot of blank lines
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More lenient validation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove or
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Simpler logic
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Expand docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Better docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Dogfood
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More writeup
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move mergeAuthorMap to authors.ts
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Unbreak relative assets
* Update docs
* Clarify in docs
* simplify feed authors
* rename authorMap -> authorsMap
* mergeAuthorsMap -> getBlogPostAuthors
* website => 5 blog posts per page
* improve authors map file
* Extract new theme authors components + display in row
* add comment for meta array syntaxes
* blog => getPathsToWatch should watch authorsMap file
* remove useless v1 blog FBID frontmatter
* keep older frontmatter syntax for now
* revert blog frontmatter
* Better console message
* better blog authors frontmatter impl
* add multi authors to beta blog post + fix some authors margins
* fix React key
* Refactor: mdx loader should support a more flexible assets system (poc, not documented yet)
* better display of blog post authors: adapt layout to authors count + add line clamp
* smaller local image
* fix blog feed tests
* fix blog frontmatter tests + improve validation schema
* add more frontmatter tests
* add tests for getAuthorsMapFilePath
* tests for validateAuthorsMapFile
* add tests for readAuthorsMapFile
* test getAuthorsMap
* exhaustive tests for getBlogPostAuthors
* fix remaining tests
* missing blog plugin author tests
* fix windows tests
* improve blog multi-author's doc
* Use new format in init template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Improve error message
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* update feed snapshot
* blog authors: limit to 2 cols + fix margins for no authors
* minor doc improvements
* better init template blog posts, demonstrating Blog features
* replace the legacy blog author frontmatter in remaining places
* Prefer using clsx
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* cleanup getColClassName
* remove blog author name/title line-clamping
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-26 12:21:58 +02:00
Paul O’Shannessy
8341527fc9
refactor: rename Git master branch to main ( #5345 )
...
* Prepare to renaming master branch to main
* Update CONTRIBUTING.md
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json
* missing master -> main replaces
* useless char
* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required
* fix versioning page
* fix vercel links
* update deployment.mdx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
Joshua Chen
28e25992ab
feat: new init template classic-typescript ( #5233 )
...
* Add typescript template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Complete CLI
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove d.ts file
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Revert lock file changes
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Regenerate lock
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add stylelint ignore
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix tsconfig
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Attempt to use symlink
* More symlinks
* Link all markdown
* Link source files
* Change to relative links
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix blogs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Link config
* Documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add option to index
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add option
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix copying
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Provide suffix
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Always have colored output
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove return signature
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update generate examples
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update lock
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix tsconfig
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Use latest docusaurus
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update lock
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add type def
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* init: make classic first in list + mark as recommended + minor refactors
* remove types.d.ts
* add "yarn typecheck" script
* Minor tweaks
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Generate example for TS
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add comment
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* No emit when running tsc
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* FIx generate examples
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove compiler options
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* This looks better
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Use new tsconfig
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-06 19:11:36 +02:00
Sébastien Lorber
b3e89d2a86
feat: docusaurus.new + improved StackBlitz playground ( #5235 )
...
* Upgrade playground shortcut domain to docusaurus.new
* update generateExamples
* update generateExamples + re-generate with stackblitz config
* test
* test
* test
* test
* test
* update examples
* upgrade lockfile
* fix yarnlock
* fix yarnlock
2021-07-28 19:27:58 +02:00
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
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
