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
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
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
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
15e73daae7
feat(v2): global data + useGlobalData + docs versions dropdown ( #2971 )
...
* doc components initial simplification
* doc components initial simplification
* add docContext test
* Add poc of global data system + use it in the theme
* Revert "doc components initial simplification"
This reverts commit f657b4c4
2020-07-21 11:16:08 +02:00
Jeremy Asuncion
9b3da59886
feat(v2): Plugin for Offline/PWA support ( #2205 )
...
* implement PWA plugin
* added pwa support for docusaurus website
* moved sw registration to client module
* moved compile function to webpack util
* build sw using webpack and render pwa popup
* implement @theme/PwaReloadPopup
* update website sw to use modules
* updated pwa readme
* fix header lint errors
* apply code formatting
* cache files only for mobile, saveData, or installed pwa
* added comments about clearing registrations
* fixed prettier error
* updated pwa README
* fix README JS
* move /blog => /blog/index.html logic to else branch
* add `alwaysPrecache` option
* updated docusaurus-plugin-pwa version
* added pwa to using-plugins.md
* review fixes
* re-disable restricted-globals to use self in service worker
* useless doc
* Update packages/docusaurus-plugin-pwa/README.md
Co-authored-by: Reece Dunham <me@rdil.rocks>
* Update packages/docusaurus-plugin-pwa/README.md
* update a bit pwa doc + minor refactors
* minor refactors + add workbox debug mode
* env PWA_ prefix
* typo
* minor refactor
* fix file output
* add serve:v2:ssl yarn command
* minor pwa fixes
* typo
* add dynamic import comment in SW
* comment
* let the PWA plugin implement its reload popup on his own
* pwa: add Joi options validation
* pwa plugin should have its own webpack/babel custom setup
* PWA:
- debug logs
- better SW params system
- offline mode activation strategies
- docs
* add pwa install gif
* pwa: popup -> reloadPopup + minor refactors
* fix process.env reading + better debug log
* minor fixes
* minor changes
* minor changes
Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Reece Dunham <me@rdil.rocks>
2020-07-08 12:32:41 +02:00
Sébastien Lorber
a5b2b6056b
feat(v2): add disableVersioning config to docs plugin ( #2989 )
...
* add disableVersioning config to docs plugin
* fix test
* fix test
2020-07-01 19:03:59 +02:00
Alexey Pyltsyn
bdffd28b9f
feat(v2): allow skipping build docs for next version ( #2877 )
...
* feat(v2): allow skipping build docs for next version
* Refactor
* Refactor
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-06-25 17:21:05 +02:00
Sébastien Lorber
20930dc837
docs(v2): add plugin redirects production build note ( #2983 )
...
* add plugin redirects production build note
* Update using-plugins.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-06-24 20:13:32 +02:00
Colin Diesh
4aa77651d3
docs(v2): update docs about creating a new plugin #2963
2020-06-19 15:32:36 +02:00
matbub
56067e4add
docs(v2): fix typos in plugin-content-pages example ( #2967 )
2020-06-19 14:17:28 +08:00
Teik Jun
8eed245000
docs(v2): add documentation for multiple blogs ( #2933 )
...
* docs(v2): add documentation for multiple blogs
* docs(v2): fix typos of docusaurus
* docs(v2): make the same changes in the latest version of documentation
* docs(v2): remove an empty blockquote
* docs(v2): improve documentation for multiple blogs
2020-06-15 03:18:37 +08:00
slorber
f6d1b2b9ca
add type comments to createRedirects doc
2020-06-03 20:09:56 +02:00
slorber
812daa8af5
improve doc
2020-06-03 18:13:10 +02:00
slorber
4e8b361d00
remove github pages mention for server-side redirects
2020-06-03 15:17:02 +02:00
Sébastien Lorber
c251eaf7b8
Update website/docs/using-plugins.md
...
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-03 12:55:09 +02:00
slorber
67f88c12e7
doc typo
2020-06-01 17:38:49 +02:00
slorber
b8168e2287
document @docusaurus/plugin-client-redirects in migration guide + fix doc typo
2020-06-01 17:33:20 +02:00
slorber
d6afb44082
add doc for @docusaurus/plugin-client-redirects
2020-05-27 16:14:18 +02:00
Yangshun Tay
2dbd0488d7
docs(v2): document beforeDefaultRemarkPlugins and beforeDefaultRehypePlugins
2020-05-23 06:12:24 +08:00
Alexey Pyltsyn
fc161b8455
docs(v2): various improvements ( #2768 )
2020-05-18 11:37:53 +08:00
Alexey Pyltsyn
00a8e9e365
feat(v2): allow home page for docs ( #2652 )
...
* feat(v2): allow home page for docs
* Refactor
* Remove debugging info 🤦♂️
* Add sort routes for first test case
* Sort child routes for consistency
2020-05-17 17:48:02 +08:00
Noah Silvera
a8ab0d661e
docs(v2): mention that plugin-ideal-image only perform compression on a production build ( #2572 )
...
* Add a note that `plugin-ideal-image` only perform compression on a production build.
In reference to https://github.com/facebook/docusaurus/issues/2571
* Update using-plugins.md
* Update using-plugins.md
* Update using-plugins.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-10 10:48:20 +08:00
Noah Silvera
dcf91ebfe4
docs(v2): fix syntax error for plugin config ( #2570 )
...
* Fix syntax error for plugin config
* Update using-plugins.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-10 10:43:02 +08:00
Fanny
5e664a1f26
feat(v2): add edit url in post page ( #2524 )
...
* Add edit page url in docs
* feat(v2): Create EditPage component
* feat(v2): Improve component
* Add test
* çhore(v2): update description
* çhore(v2): update url
* fix(v2): test
* fix(v2): test
* feat(v2): change the prop of EditPage component
* chore(v2): Remove packages
* feat(v2): Update old tests
* chore(v2): fix package
* fix(v2): fix editUrl
* docs(v2): document editUrl
* --
* --
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-05 17:34:48 +08:00
José Renan
95fdfe7e15
feat(v2): add blog post estimated reading time ( #2531 )
...
* feat: add estimated reading time to blog posts
* docs: add showReadingTime on plugin docs
* test: update plugin-content-blog tests to cover readingTime
* Update index.js
* Update using-plugins.md
* Update index.js
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-05 15:08:42 +08:00
Yangshun Tay
3dd83be988
docs(v2): proofread docs ( #2527 )
2020-04-04 14:05:59 +08:00
Yangshun Tay
36ea74504e
docs(v2): use codeblock title syntax instead of comments ( #2473 )
2020-03-29 01:08:50 +08:00
Alexey Pyltsyn
8d31c21fe5
docs(v2): fix misc styling
2020-03-24 09:56:02 +03:00
Noah Silvera
d4bbf000d5
docs(v2): add examples to plugin usage doc ( #2351 )
...
Add an example value for the remarkPlugins config option for plugin-content-blog and plugin-content docs
Initially I tried to use a string value with this config and got an esoteric error. Having an example of it's usage would help.
2020-03-03 11:19:01 +08:00
Zhenchao Cai
b25eb5dd36
docs(v2): move the quotes to remark admonitions ( #2313 )
...
* docs(v2): move the quotes to remark admonitions
* Delete package-lock.json
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-02-23 18:11:37 +08:00
Paulus Schoutsen
6a1bc254cc
Make blog plugin config example valid ( #2300 )
...
* Make blog plugin config example valid
* Update using-plugins.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-02-19 20:53:32 +03:00
Reece Dunham
ad031a15a4
feat(v2): support IP anonymization for Google Analytics plugin ( #2148 )
...
* Support IP anonymization for google analytics
* Fixes
* Add docs
* typo fix
* Fix syntax
* document in suggested place
* attempted to add functionality to gtag plugin
* Remove from api-site-config
* document in appropriate places
* fix anonymize IP
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-01-12 21:27:08 +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
endiliey
2856b328a5
chore(v2): fix typo in docs, remove dead/redundant stuff
2019-11-26 16:49:58 +07:00
Endi
91b261af7a
docs(v2): more examples on lifecycle apis, cleanup ( #2051 )
...
* docs(v2): more examples on lifecycle apis, cleanup
* typo
2019-11-25 10:31: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
Yangshun Tay
f635f9aba2
docs(v2): code block line highlighting ( #1904 )
...
* docs(v2): code block line highlighting
* misc: update CHANGELOG
* misc: respond to review
* docs: add line highlighting to the template
2019-10-29 14:59:24 +08:00
Endi
2bbfbf88d6
docs(v2): update plugins, presets and themes docs ( #1889 )
...
* docs(v2): update plugins, presets and themes docs
* ideal image plugin
* proof reading
* Merge master
2019-10-26 15:10:48 +07:00
endiliey
7d5920b30c
docs(v2): fix outdated/ wrong info
2019-10-05 15:39:22 +07:00
Wei Gao
f4f458460c
docs(v2) themes ( #1645 )
...
* More prep
* rename xxx-api to api-xxx
* move content around for plugins and themes
* wip docs: using themes
* docs(v2): tweak using plugins
* docs(v2): list official themes in docs
* docs(v2): advanced themes
* wip notes for lifecycle apis
* resolve PR review discussions
* lower case "theme"
* better intro for using themes
* add a simple README to @docusaurus/theme-classic
* remove list of components from theme classic README and replace with link to directory
2019-07-26 12:00:40 +07:00
endiliey
568d9fd7dd
chore(v2): update changelog
2019-07-14 17:32:48 +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
Wei Gao
95fde5f827
docs(v2): refactor docs for better outline and welcoming PRs ( #1641 )
...
* docs(v2): refactor docs for better outline and welcoming PRs
* docs(v2): update docs
2019-07-07 23:14:49 -07:00
Wei Gao
504fcb1b4a
docs(v2): plugins ( #1629 )
2019-07-02 23:12:22 -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
