Commit graph

34 commits

Author SHA1 Message Date
Fernando Maia
b366ba5603
feat: shorthands for themes/plugins/presets configuration (#5930)
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2021-12-03 18:23:12 +01:00
William Poetra Yoga
ca9bd244aa
feat: allow user to specify deploymentBranch property in docusaurus.config.js (#5841)
* feat: allow user to specify deploymentBranch property in docusaurus.config.js

* docs: remove extra backtick

* docs: fix broken code block
2021-10-31 12:29:22 +08:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Alexey Pyltsyn
d25e0f4d0f
fix(v2): fix warning and improve styling inline TOC (#4163) 2021-02-03 12:11:42 +01:00
Sébastien Lorber
8a934ac9b7
docs(v2): Use the TOCInline component in config doc (#4084) 2021-01-21 18:41:52 +01:00
Varshit Shah
9626e547c9
docs(v2): Removed unnecessary closing parenthesis (#3924) 2020-12-16 16:44:47 +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
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
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.

* feat(v2): add option for changing duplicate path behavior

* feat(v2): decouple logging from logic and detect duplicate routes in one pass

* test(v2): fix failing tests

* test(v2): add tests for duplicateRoutes

* test(v2): add test for handleDuplicateRoutes

* style(v2): add else statement

* docs(v2): modify documentation for duplicate routes

* docs(v2): move doc into guides folder

* fix(v2): fix broken links

* docs(v2): move docs for docusaurus config into api folder

* style(v2): add comments

* refactor(v2): extract getFinalRoutes

* refactor(v2): scope getFinalRoutes to docusaurus package

* test(v2): remove obsolete snapshots

* docs(v2): remove some docs

* fix(v2): rerun github actions

* docs(v2): change slug of docs in api folder

* refactor(v2): extract out a reportMessage method

* refactor(v2): extract getAllFinalRoutes

* test(v2): replace snapshots with actual value

* style(v2): remove unnecessary comment and change type

* chore(v2): remove unused dependency

* style(v2): remove unused code

* Update packages/docusaurus/src/server/utils.ts

* Update website/docs/guides/creating-pages.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-07-31 21:14:49 +02:00
Sébastien Lorber
1272ab83fb
feat(v2): useDocusaurusContext().siteMetadata (#3058) 2020-07-16 12:46:21 +02:00
Sam Zhou
729b3cae9b
feat(v2): Allow configuring babel via babel.config.js (#2903)
* feat(v2): Allow configuring babel via docusaurus.config.js

* Use api.caller feature from babel to avoid expose isServer to users

* Remove unused optional config key

* Make babel loader resolve and require config file
2020-06-12 11:03:00 +08:00
Alexey Pyltsyn
fc161b8455
docs(v2): various improvements (#2768) 2020-05-18 11:37:53 +08:00
Reece Dunham
a7b802f31a
docs(v2): improve grammar (#2606)
Signed-off-by: Reece Dunham <me@rdil.rocks>
2020-04-14 23:26:55 +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
Yangshun Tay
36ea74504e
docs(v2): use codeblock title syntax instead of comments (#2473) 2020-03-29 01:08:50 +08:00
Linus Långberg
1b1b122f45
docs(v2): clarify instructions on docs-only mode (#2395)
* docs(v2): clarify instructions on docs-only mode

* Update configuration.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-03-10 16:38:09 +08:00
Linus Långberg
ad3accd3fb
docs(v2): add section for docs-only mode (#2378)
* docs(v2): add section for docs-only mode

* docs(v2): use correct section in document

Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-03-08 21:09:40 +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
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
Eric Carboni
b027db1b34 docs(v1): remove exclusive language (#1961)
* Initial commit to replace easy, easily, simple, just, of course

* Revert ordered list change
2019-11-11 14:06:54 -08:00
Kate Bartolo
3f8cb78ba9 docs(v2): theme, plugin, and preset config (#1929)
* docs(v2): theme, plugin, and preset config

* change tabs to spaces

* change theme example
2019-11-03 17:59:39 +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
a9f752cf23
docs(v2): update config docs (#1885) 2019-10-25 23:35:02 +07:00
Endi
1c59b5bc1c
chore(v2): upgrade deps and add missing docs on docusaurus config (#1693)
* chore(v2): upgrade deps and add missing docs on docusaurus config

* review
2019-07-23 23:06:15 +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
e2338bd0c2
docs(v2): minor revisions on live coding docs (#1594)
* Use relative file path in md

* Need .md file extention in link

* docs(v2): minor revisions on live coding block
2019-06-09 12:04:37 +08:00
Wei Gao
96c048b040 docs(v2): remove links to other page that looks like partial toc (#1579) 2019-06-06 11:53:38 -07:00
Endi
26e4c1d883
fix(v2): fix scrolling problem for location with hash (#1576) 2019-06-06 23:28:28 +07:00
endiliey
38af934464 chore(v2): improve typing 2019-06-03 20:55:45 +08:00
Wei Gao
5af8cd566e docs(v2): Configuration (#1539)
* docs(v2): Configuration

* Revamp docs for configurations

* Move configuration guide to a lower position on the sidebar

* Use filename links inside md

* Wrap up configuration docs

* Update docusaurus.config.js.md
2019-06-03 15:59:32 +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