Sébastien Lorber
5b79f2ebc2
feat(v2): site client modules ( #3545 )
...
* site client modules
* Update website/docs/api/docusaurus.config.js.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-10-07 14:44:14 +03:00
Sébastien Lorber
9ba28a378f
feat(v2): doc navbar item type ( #3539 )
...
* provide DocNavbarItem type
* update snapshots
* Fix Docusaurus tabs CSS
* revert navbar tabs css/style changes, instead apply simple navbar__link--active class + make it configurable
* Update website/docs/theme-classic.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
* add dropdownActiveClassDisabled option
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-10-07 14:42:24 +03:00
Alexey Pyltsyn
9134b1396b
docs: various fixes and improvements ( #3546 )
2020-10-07 12:39:47 +02:00
SaintMalik
6dec70b69f
docs(v2): Fix url bugs in v2 docs ( #3534 )
...
* Fix broken link in the documentation
* Fix broken url caused by typo
* Fix broken link caused by typo
2020-10-04 19:46:48 +02:00
Sébastien Lorber
637fe0087d
feat(v2): add TOC to markdown pages #3529
2020-10-03 17:33:36 +02:00
Sébastien Lorber
dc31dad1de
docs(v2): add doc for wrapping theme components with @theme-original and @theme-init ( #3502 )
...
* add doc for wrapping theme components
* fix tests
* Minor improvements
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-09-30 18:15:47 +02:00
Rémi Doreau
d3a01458a3
feat(v2): add beforeDefaultRemarkPlugins/beforeDefaultRehypePlugins options to all md content plugins ( #3467 )
...
* fix(plugin-content-docs): add beforeDefaultRemarkPlugins + beforeDefaultRehypePlugins options
* fix(plugin-content-blog): add beforeDefaultRemarkPlugins + beforeDefaultRehypePlugins options
* fix(plugin-content-pages): add beforeDefaultRemarkPlugins + beforeDefaultRehypePlugins options
* feat(website-docs): overriding remark-rehype plugins
* fix(plugin-content): update beforeDefaultRehypePlugins/beforeDefaultRemarkPlugins types
* fix(plugin-content-docs): fix tests
2020-09-29 14:48:34 +02:00
Sébastien Lorber
6aeccc685e
docs(v2): grammar fix ( #3493 )
2020-09-28 19:29:51 +02:00
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
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
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
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
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
2020-09-02 15:42:34 +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
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
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
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
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
Franklyn Chisom
0d489aeb9e
docs: corrected some few typos in the docusaurus tech docs ( #3276 )
...
* corrected some few typos
* Update blog.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-08-14 11:38:54 +02:00
Bogdan
b75a7150b2
docs(v2): fix migration command ( #3249 )
2020-08-11 17:16:48 +02:00
Sébastien Lorber
0a33a52301
fix(v2): deprecate docs homePageId in favor of frontmatter "slug: /" ( #3228 )
...
* homePageId => deprecated
* docs prettier
2020-08-06 18:31:50 +02:00
Anshul Goyal
ef9314e5a4
feat(v2): update swizzle command to suggest component/theme ( #3021 )
...
* update swizzle command
* change messages
* fix formatting
* add docs
* fix component lisiting
* allow themes to provide a list for safe swizzle components
* support both commanjs and ES exports
* fix debug plugin doesn't swizzle
* add dos
* remove unsed file
* fix docs plugin not swizzle properly
* fix console.log
* use new validate
* fix linting
* use config options for plugin
* rerun test
* fix type
* add a comment
* Update packages/docusaurus/src/commands/swizzle.ts
* Update packages/docusaurus/src/commands/swizzle.ts
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-08-06 13:53:03 +02:00
Anshul Goyal
f234c407f1
feat(v2): add support to ignore files in pages plugin ( #3196 )
...
* add support to ignore pages
* fix import problem
* Update website/docs/guides/creating-pages.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
* Revert "fix import problem"
This reverts commit 4457a2e938
2020-08-05 21:35:55 +02:00
Anshul Goyal
25b70b5342
fix(v2): fix svg loader ( #3202 )
...
* fix loader
* Update website/docs/markdown-features.mdx
* Update website/docs/markdown-features.mdx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-08-05 19:19:20 +02:00
Drew Alexander
fdf08e787f
docs(v2): Added switch config docs to theme-classic API ( #3194 )
...
* Reduce commented info in API
* Update yarn lock
* Add switch config documentation to theme-classic
* Expand highlighted code block
* Add unicode example to icons
* Punctuation and white space fixes
* Revert changed comment
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
* Remove camel case comment
* Revert api style comment
* Revert "Update yarn lock"
This reverts commit 5b5b3d39a1
2020-08-05 18:54:41 +02:00
Sébastien Lorber
59f705ee66
feat(v2): blog + docs multi-instance plugins ( #3204 )
...
* stable createData namespacing + second-blog dogfooding
* Docs: support multi-instance + make community docs a separate instance
* tests: add 2nd docs instance to versioned site
* fix docs version cli tests
* fix docs versioning cli
* typo
* team: add link to my site
* better extendCli integration
* fix metadata tests
* tests for versioned site with second docs instance
* move some validation code to utils-validation
* fix missing dependency
* fix bad compiled output due to importing constants in ./client folder
* make docs tests easier to maintain
* refactors
* prevent lodash imports in client bundle
* redirect old community docs to new urls
2020-08-05 18:27:55 +02:00
alex busnelli
0d7314a6f7
docs(v2): removed duplicate text under "Using React" section ( #3201 )
...
* removed duplicate text under "Using React" section
* docs(v2): removed duplicate text under "Using React" section in trunk docs
2020-08-04 07:30:22 +08:00
Anshul Goyal
325559933f
feat(v2): add support to import assets using relative link in markdown syntax ( #3096 )
...
* add a rehyper plugin
* fix yarn.lok
* add target
* convert to remark
* add docs
* remove unused package
* remove file-loader
* add test for file-loader
* fix test
2020-08-03 15:19:12 +02:00
Sébastien Lorber
48b996773c
chore(v2): prepare v2.0.0.alpha-61 release ( #3182 )
...
* alpha 61 release
* doc prettier
* v2.0.0-alpha.61
2020-08-01 15:24:46 +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
Sébastien Lorber
7cceee7e38
feat(v2): markdown pages ( #3158 )
...
* markdown pages POC
* add remark admonition, mdx provider, yarn2npm...
* pluginContentPages md/mdx tests
* pluginContentPages md/mdx tests
* add relative file path test link to showcase link problem
* fix Markdown pages issues after merge
* fix broken links found in markdown pages
* fix tests
* factorize common validation in @docusaurus/utils-validation
* add some documentation
* add using plugins doc
* minor md pages fixes
2020-07-31 16:04:56 +02:00
Drew Alexander
53b28d2bb2
feat(v2): dark mode toggle customization ( #3127 )
...
* Add dark/light style fields to config
* Update yarn.lock
* Remove css content
* Add documentation
* Add icon fields to toggle component
* Add config validation fields
* Remove changes from docusaurus.config
* Add unicode documentation example
* Fix default values
* Add color mode config default
* Add lodash to theme-classic
* Change themeConfigSchema name to match other packages
* Add themeConfig color-mode tests
* Add default config merge function
* Remove unneeded object merging
* Add more documentation
2020-07-31 15:39:12 +02:00
Xuqian
4af25cd597
feat(v2): support custom description for blog-only mode ( #2359 )
...
* feat: support custom description on blog page
resolve conflicts
* feat(v2): allow additional props to pass to route components
resolve conflicts
* Update blogDescription feature
* Update doc for blogDescription
* Remove test blogDescription config
* Fix blogDescription schema validation
* Fix minor errors
Co-authored-by: Xuqian <zxuqian@163.com>
2020-07-30 15:41:15 +02:00
Sébastien Lorber
ee2d1b42f6
docs(v2): add myself to /team page + add TeamProfileCard component ( #3145 )
...
* add myself to /team page + add TeamProfileCard component
* apply col classes from parent to make TeamProfileCard more reusable
2020-07-28 20:18:15 +02:00
Sébastien Lorber
e1b2963f31
fix(v2): absolute Links should be automatically prefixed by baseurl ( #3143 )
...
* put back the automatic withBaseUrl call, but only for urls starting with / (because useBaseUrl behavior is buggy and forces relative links to absolute links)
* fix Link typo
2020-07-28 19:40:34 +02:00
Sébastien Lorber
d25d4b08f6
fix(v2): remove buggy routesLoaded + deprecate routesLoaded lifecycle ( #3141 )
...
* remove bad deletion of docs / if conflicting with a page
* deprecate routesLoaded
2020-07-28 14:28:14 +02:00
