Commit graph

27 commits

Author SHA1 Message Date
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