Commit graph

851 commits

Author SHA1 Message Date
aakhtar3
a17693dd1b
docs(v2): Added drone.io publish docs #3491 (#3492) 2020-09-28 18:32:07 +02:00
Bartosz Kaszubowski
ae2c063929
feat(v2): allow to use array of files in customCss field (#3474)
* feat(v2): allow to use array of files in customCss field

* customCss array:
- fix bug (push instead of concat)
- update docs
- add theme config validation + tests

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2020-09-28 18:15:41 +02:00
Henry Vélez
cc31567459
feat(v2): new docusaurus clear command (#3446)
* feat: new docusaurus clear command

* Update packages/docusaurus/bin/docusaurus.js

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>

* docs: new docusaurus clear command

* fix doc

* update monorepo clear cmd

* make clear async function wait for deletes to complete + factorize a bit

* prettier fix

* better clear docs

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-09-28 16:33:35 +02:00
Bartosz Kaszubowski
c0d8238c49
feat(v2): add ability to set custom title delimiter in config (#3460)
* feat(v2): add custom title delimiter to the theme classic

* fix validation tests

* remove title delimiter fallback

* move titleDelimiter to main config, update theme-bootstrap

* remove test value from config

* update test snapshot

* Improve docs

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-09-26 00:25:19 +03:00
Tim Gates
8bed33b81f
docs(v2): fix simple typo, localy -> locally (#3480)
There is a small typo in website/docs/cli.md, website/docs/deployment.md, website/versioned_docs/version-2.0.0-alpha.60/cli.md, website/versioned_docs/version-2.0.0-alpha.60/deployment.md, website/versioned_docs/version-2.0.0-alpha.61/cli.md, website/versioned_docs/version-2.0.0-alpha.61/deployment.md, website/versioned_docs/version-2.0.0-alpha.62/cli.md, website/versioned_docs/version-2.0.0-alpha.62/deployment.md, website/versioned_docs/version-2.0.0-alpha.63/cli.md, website/versioned_docs/version-2.0.0-alpha.63/deployment.md, website/versioned_docs/version-2.0.0-alpha.64/cli.md, website/versioned_docs/version-2.0.0-alpha.64/deployment.md.

Should read `locally` rather than `localy`.
2020-09-23 22:50:06 +03:00
Alexey Pyltsyn
02f96286e5
docs(v2): remove redundant new line in code block (#3479) 2020-09-23 19:16:04 +03:00
Alexey Pyltsyn
aeb7aa3901
chore(v2): remove alpha 58 doc (#3477) 2020-09-23 23:38:53 +08:00
Bartosz Kaszubowski
f9944cb2fc
feat(v2): add optional custom wrapper class name for pages based on theme classic Layout (#3457)
* feat(v2): add optional custom wrapper class name for pages based on theme classic Layout

* feat(v2): add optional custom wrapper class name for markdown pages

* fix TS types
2020-09-23 15:38:17 +03:00
Jeremy Hager
521ef59908
docs(v2): add deployment command for PowerShell (#3459)
* Added powershell command for deployment
- specified batch command is for cmd
- added powershell as an option for deployment, changed to single quotes

* - This affects the following versioned docs:
  - 2.0.0-alpha.63
  - 2.0.0-alpha.64
  - Next (Dev)

* Changed deploy commands to tabbed
- bash, windows, powershell, and cmd are now part of <tabs>
- default value is bash

* Changed deployment commands to tabs in v63 and 64
- Next (dev) now has better syntax
- 2.0.0-alpha-63 and 2.0.0-alpha-64 now include the tabs as well

* Updated lables in deploy and cmd to Windows
- Labels now are first-letter uppercase
  - eg. bash -> Bash
- cmd is now Windows to align with original docs

* Removed `<Tab>` spacing in deploy section
- Removed spacing at end of `values` statement
- Removed spacing between `<Tabs>` and `<TabItem>`
- build successful locally
2020-09-19 10:16:11 +03:00
Bartosz Kaszubowski
a0cac48cd4
chore(v2): fix theme classic navbar style docs (#3448) 2020-09-16 10:46:28 +03:00
Joel Marcey
ca8f3811b5
misc: default Docusaurus Website UX (#3455) 2020-09-16 10:15:45 +08:00
Sébastien Lorber
9bf4dfb275
chore(v2): prepare v2.0.0.alpha-64 release (#3440)
* add 2.0.0 alpha 64 files

* v2.0.0-alpha.64
2020-09-11 20:35:05 +02:00
Bartosz Kaszubowski
086bee287d
feat(v2): add style property to theme-classic navbar (#3432)
* feat(v2): add style property to theme-classic navbar

* revert config test change

* review changes
2020-09-11 18:03:06 +02:00
Sébastien Lorber
c0ce83f243
fix(v2): fix manifest to support baseUrl (#3438) 2020-09-11 16:26:44 +02:00
Ash
37989a00c3
fix(v2): Correctly resolve sw.js path on windows (#3436)
* fix(v2): Correctly resolve sw.js path on windows

* Just fixing the icons too

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-09-11 15:19:11 +02:00
Thad Guidry
94527b0b62
docs(v2): fix grammar (#3428)
Co-authored-by: Andrulko <andriy@crowdin.com>
2020-09-10 12:33:43 +02:00
Méril
77db144378
docs(v2): reference Eta's syntax in ssrTemplate section (#3425) 2020-09-09 15:49:11 +02:00
Méril
d844ff6107
feat(v2): add an option to toggle trailing slash for urls in sitemap (#3426) 2020-09-09 15:48:47 +02:00
Rutik Wankhade
3638b1651a
docs(v2): minor typo fix (#3423)
* docs: minor typo fix 

Markdown import example in website/src/pages/examples/markdownPageExample.md imports the wrong chapter.
See this comment f234c407f1 (r42067403)

### Have you read the [ Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#pull-requests)?
(Yes)

* Update website/src/pages/examples/markdownPageExample.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-09-08 19:49:33 +02:00
Sébastien Lorber
21852948ce
feat(v2): ability to add/override theme html metadatas (#3406)
* ability to add/override theme html metadatas
see https://github.com/facebook/docusaurus/issues/3024

* refactor/fix validateThemeConfig tests
2020-09-04 16:36:56 +02:00
Sébastien Lorber
8af3ad4250
chore(v2): prepare v2.0.0.alpha-63 release (#3400)
* add alpha 63 + remove +3month old versions

* update publish guide

* v2.0.0-alpha.63
2020-09-03 18:52:03 +02:00
Sébastien Lorber
0baf3c2e54
fix(v2): DocSearch should keep working after a new release (part 2/2) (#3397) 2020-09-03 17:28:24 +02:00
Sébastien Lorber
9c34f68a7a
fix(v2): DocSearch should keep working after a new release (#3393)
* We should create an alias for searching last version of docs on DocSearch/Algolia, so that on new version publish, search still works even if new version is not already indexed (https://github.com/facebook/docusaurus/issues/3391)

* commit missing snapshot

* update after algolia changes

* put back facetFilters: [`version:${versions[0]}`] until latest facet is indexed
2020-09-03 14:35:46 +02:00
Méril
3ace60043b
feat(v2): allow users to specify a custom ssr HTML template (#3387)
* feat(v2): allow users to specify a custom ssr HTML template

* docs(v2): add ssrTemplate property to docusaurus.config.js page
2020-09-02 19:29:04 +02:00
Sébastien Lorber
9857f7b2b5
feat(v2): officially release @docusaurus/plugin-debug (#3392)
* Add json styling to config debug

* Style debug content page

* Add style and collapse depth to json viewer

* Add style to debug layout

* Add style to metadata debug

* Add style support to registry debugger

* Remove default content if other instances are present

* Change colors for more contrast

* Add debug routes styles

* Add active link style

* Fix container css issues

* Style registry debug page

* Remove unused style modules

* Add white space to style files

* Add font scaling

* Fix prettier errors

* Add child routes to route debug

* Readd default content plugin json

* Add empty home page to debug

* Prettier

* Revert "Add empty home page to debug"
This should be included in a separate PR
This reverts commit 9c43c9f7fb.

* Set colors to dark theme

* Add plugin debug doc + minor fixes + expose global data

* more debug plugin doc

Co-authored-by: Drewbi <drewalexander986@gmail.com>
2020-09-02 15:42:34 +02:00
Sam Ko
8f24a0a149
docs(v1, v2): Update Deploy to Vercel guide (#3390)
* Update Vercel guide for version-2.0.0-alpha.62

* Update Vercel guides for Docusaurus v1
2020-09-02 12:19:54 +02:00
Sébastien Lorber
ab3ebdad39
chore(v2): pin exact dependency versions (#3386)
* Attempt to pin all dependency versions exactly for https://github.com/facebook/docusaurus/issues/3371

* warn if @docusaurus package versions mismatch

* fix yarn lock
2020-09-02 11:42:17 +02:00
Bartosz Kaszubowski
e8e16a45d3
feat(v2): add isCloseable property for theme-classic announcement bar (#3388)
* feat(v2): add `isCloseable` property for announcement bar

* correct styling for non-closeable announcement

* fix tests
2020-09-02 11:41:38 +02:00
Sébastien Lorber
5359d61d9e
fix(v2): allow using classic theme/preset without the docs plugin (#3382)
* deprecated nextVersionLabel option

* useActivePlugin failfast option

* remove deprecated option nextVersionLabel

* routeBasePath: '' should be forbidden

* routeBasePath: '' should be forbidden

* Docs: do not show version badge if there is only 1 version: https://github.com/facebook/docusaurus/issues/3362

* allow sidebars file to not exist: fallback to empty sidebars
https://githu.com/facebook/docusaurus/issues/3366

* Ability to use classic theme/preset while not using docs/pages without trouble.
https://github.com/facebook/docusaurus/issues/3360

* fix netlify redirects

* do not throw if useDocs do not load?

* netlify deploy typo

* try to fix useDocs

* docs(v2): update Deploy to Vercel guide (#3344)

* filter annoying useDocs conditional require warning

* netlify deploy preview homepage

* typo

* try to trigger again CLA bot

Co-authored-by: Sam Ko <sam@vercel.com>
2020-09-01 19:38:11 +02:00
Sébastien Lorber
a4769e3f30
fix(v2): alpha 62 doc fixes (#3381)
* deprecated nextVersionLabel option

* useActivePlugin failfast option

* remove deprecated option nextVersionLabel

* routeBasePath: '' should be forbidden

* routeBasePath: '' should be forbidden

* Docs: do not show version badge if there is only 1 version: https://github.com/facebook/docusaurus/issues/3362

* allow sidebars file to not exist: fallback to empty sidebars
https://githu.com/facebook/docusaurus/issues/3366
2020-09-01 16:31:33 +02:00
Sam Ko
2a3fe86579
docs(v2): update Deploy to Vercel guide (#3344) 2020-09-01 12:14:39 +02:00
Sébastien Lorber
d8cfabb66a
feat(v2): docs options.onlyIncludeVersions (#3373)
* docs options.onlyIncludeVersions

* adapt docsVersionDropdown if we render a single version

* fix bad error message

* fix netlify deploy when versioning is disabled
2020-08-31 17:08:24 +02:00
Thad Guidry
149d82c730
docs(v2): fix grammar on introduction page (#3369) 2020-08-31 01:16:12 +08:00
Sébastien Lorber
4f448bd54b
chore(v2): prepare v2.0.0.alpha-62 release (#3359)
* Add alpha 62

* v2.0.0-alpha.62
2020-08-28 19:17:56 +02:00
Sébastien Lorber
ae877f2990
feat(v2): docs version configuration: lastVersion, version.{path,label} (#3357)
* add new docs versioning options

* Add some tests for new versioning options

* Add some docs for version configurations

* try to fix broken link detection after /docs/ root paths have been removed on deploy previews

* improve dev/deploypreview versioning configurations

* disable custom current version path, as it produces broken links

* readVersionDocs should not be order sensitive

* fix versions page according to versioning config

* fix versions page according to versioning config
2020-08-28 18:37:49 +02:00
Sébastien Lorber
c7fc781ce0
fix(v2): linking to asset or external html page -> don't use history.push() (#3347)
* Rework markdown links to asset require processing + add test page

* implement pathname:// protocol / escape hatch at the Link level

* linking to assets: fix tests + avoid creating an useless nested paragraph

* fix assets linking doc

* attempt to fix windows e2e test

* try to fix windows errors
2020-08-28 12:47:03 +02:00
Sam Zhou
bd9b6618c1
feat(v2): Provide typing to most of the theme-classic components (#3348)
* feat(v2): Provide typing to most of the theme-classic components

* Expose type to the end users and dogfood it in v2 website
2020-08-28 12:06:37 +02:00
Nisarag
306d3afc0a
adding team profile card about myself (#3336) 2020-08-26 11:38:12 +08:00
Yangshun Tay
d04a30cc93
docs(v2): update team profile (#3335)
* docs(v2): update team profile

* misc: add Sam intro
2020-08-25 20:42:46 +02:00
Drew Alexander
c7daf32642
docs(v2): add Drew to Fellows section (#3334)
* Add me to Fellows section

* Update team.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-08-25 22:10:18 +08:00
Teik Jun
878ce3132b
docs(v2): add anshul and tj to fellows team (#3333) 2020-08-25 20:54:23 +08:00
Daniel Wilkowski
0f357606cd
docs(v2): add "T-Regx" website to showcase (#3310)
* Add "T-Regx" docusaurs website to showcase

* Update users.js

* Update users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-08-20 14:49:32 +02:00
Jonas Dellinger
c97dd656a9
docs(v2): showcase SpotifyAPI-NET (#3307) 2020-08-19 16:01:46 +02: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
Orta Therox
33ecc4bb17
chore(v2): tighten up the TypeScript onboarding (#3244)
* Tighten up the TypeScript onboarding

* Extend the API to cover everything used in the classic theme

* Wrap up internal TS support
2020-08-17 18:03:21 +02:00
Sébastien Lorber
a4c8a7f55b
refactor(v2): docs plugin refactor (#3245)
* safe refactorings

* safe refactors

* add code to read versions more generically

* refactor docs plugin

* refactors

* stable docs refactor

* progress on refactor

* stable docs refactor

* stable docs refactor

* stable docs refactor

* attempt to fix admonition :(

* configureWebpack docs: better typing

* more refactors

* rename cli

* refactor docs metadata processing => move to pure function

* stable docs refactor

* stable docs refactor

* named exports

* basic sidebars refactor

* add getElementsAround utils

* refactor sidebar + ordering/navigation logic

* stable retrocompatible refactor

* add proper versions metadata tests

* fix docs metadata tests

* fix docs tests

* fix test due to absolute path

* fix webpack tests

* refactor linkify + add broken markdown links warning

* fix DOM warning due to forwarding legacy prop to div element

* add todo
2020-08-17 17:50:22 +02:00
Amy Lei
473d263469
feat(v2): add toc to blog posts (#3274)
* refactor TOC into own component

* make layout consistent across blog pages
2020-08-17 14:47:19 +02:00
Vandré Leal
3ef965bae6
docs(v2): showcase Oxidizer (#3295) 2020-08-17 12:36:58 +02:00
Anshul Goyal
12e9ff6232
fix(v2): pass images in static dir to webpack-loader (#3283)
* pass static images to webpack-loader

* remove console.log

* fix windows path issue

* fix windows path issue

* add missing deps
2020-08-14 21:33:08 +02:00
Hani Mohammed
826dc8dc02
docs(v2): fix typo (#3271)
* docs(v2): fix typo

* @thehanimo docs(v2): fix typo in website/docs

* Update website/docs/deployment.md

* Update website/versioned_docs/version-2.0.0-alpha.61/deployment.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-08-14 12:11:40 +02:00