Commit graph

299 commits

Author SHA1 Message Date
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
ehsan jso
8304e8253c
docs(v2): Fix typo in markdown-features (#2973)
* Fix typo in markdown-features

The code needed to be in npm syntax in order to work with npm2yarn

* Update markdown-features.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-06-25 17:05:51 +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
Anshul Goyal
81d855355e
feat(v2): option and config validation life cycle method for official plugins (#2943)
* add validation for blog plugin

* fix wrong default component

* fix test and add yup to package.json

* remove console.log

* add validation for classic theme and code block theme

* add yup to packages

* remove console.log

* fix build

* fix logo required

* replaced yup with joi

* fix test

* remove hapi from docusuars core

* replace joi with @hapi/joi

* fix eslint

* fix remark plugin type

* change remark plugin validation to match documentation

* move schema to it's own file

* allow unknown only on outer theme object

* fix type for schema type

* fix yarn.lock

* support both commonjs and ES modules

* add docs for new lifecycle method
2020-06-24 20:08:16 +02:00
slorber
ce10646606 document that docs/blog-only modes should delete the existing homepage 2020-06-23 18:29:19 +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
Marius Andra
162870d251
docs: mention posthog-docusaurus plugin (#2957) 2020-06-18 19:30:42 +08:00
Drew Alexander
d365b7424b
docs(v2): add useThemeContext note (#2934)
* docs: add note to useThemeContext api docs

* Update example usage
2020-06-15 12:39:17 +02:00
Drew Alexander
c341f457fb
docs(v2): add router implementation note (#2935) 2020-06-15 12:37:49 +02: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
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
Sébastien Lorber
68a1bb1ebf
Merge pull request #2793 from slorber/feature/client-side-redirects
feat(v2): docusaurus-plugin-client-redirects
2020-06-10 17:36:57 +02:00
Yangshun Tay
3e43955df6 docs(v2): fix typo in ExecutionEnvironment example 2020-06-09 21:52:24 +08:00
Anshul Goyal
c97fd9f1d7
docs(v2): fix GitHub action workflow in documentation (#2910) 2020-06-09 16:29:55 +08:00
Alexey Pyltsyn
afe9ff91a4
chore(v2): replace classnames with clsx (#2895) 2020-06-07 13:40:06 +08:00
Sébastien Lorber
1003a15d1f
polish(v2): improve Docusaurus 1 to 2 migration developer experience (#2884)
* improve markdown parsing errors by adding file path to error

* typo commit

* Add default nav item position to right (as v1)

* improve error when sidebar references unexisting document

* parseMarkdownFile: improve errors by providing hint about using "" to avoid parsing errors, if using special characters

* improve subcategory migration error for Unknown sidebar item type

* improve unrecognizedFields error

* typo

* fix inline snapshots

* improve the migration docs

* improve the migration docs

* improve migration doc

* Update migrating-from-v1-to-v2.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-06-06 11:16:50 +08:00
Sam Zhou
8aa520c314
fix(v2): Do not automatically change tab when a non-existing option is selected (#2893) 2020-06-06 11:11:42 +08:00
Paul Glezen
4278cebf67
docs(v2): fix typo in command on installation page (#2886)
* Fix installation.md typo

Checking the docusaurus version should be done with

```
npx docusaurus --version
```

not 

```
npm docusaurus --version
```

otherwise it prints the version of `npm` instead of `docusaurus`.

* docs: Fixed installation.md for checking version.

Specifying `npm` for the version will yield the version of NPM
instead of docusaurus itself.  Use `npx` for the docusaurus version.
2020-06-06 04:14:53 +03:00
Yangshun Tay
2d8abe150f
docs(v2): make .nojekyll warning more obvious (#2887) 2020-06-05 10:22:06 +08:00
Sébastien Lorber
953abd8154
feat(v2): allow adding components to react-live scope (#2826)
* feat(v2): add components to react-live scope (#2807)

* fix admonition issue + improve react-live scope doc

* fix again admonition :(

* remove forwarding of mdx components to react-live scope (for now)

* remove useless dep
2020-06-04 15:18:42 +03: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
slorber
802235c768 Merge branch 'master' into feature/client-side-redirects 2020-06-03 15:16:24 +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
Sébastien Lorber
504b1b4443
Update website/docs/migrating-from-v1-to-v2.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-03 12:54:41 +02:00
Alexey Pyltsyn
e68b81bc33
fix(v2): do not create route for document that serve as docs home page (#2861) 2020-06-03 15:56:57 +08:00
Sébastien Lorber
b8de9c6ded
feat(v2): introduce docs slug in front matter (#2771)
* feat: docs pathname frontmatter (for #2697)

* feat: docs pathname frontmatter (for #2697)

* chore: comment typo

* feat: add slug frontmatter for docs

* test: add tests for versioned sites slugs

* docs: document slug feature

* test: fix tests and snapshots about doc slug feature

* docs(v2): doc slug wording

* Update website/docs/docs.md

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

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-02 20:50:30 +03:00
Alexey Pyltsyn
ed9977accc
docs(v2): description field in frontmatter of blog post (#2865) 2020-06-02 11:02:45 +03:00
Alexey Pyltsyn
c0c7457e01
feat(v2): allow specifying meta image for blog posts (#2856)
* feat(v2): allow specifying meta image for blog posts

* Update docs [skip ci]
2020-06-02 10:48:22 +03: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
hackerman
7cba7f0d06
docs(v2): _index docs page does not show a sidebar (#2839)
* docs: _index docs page does not show a sidebar

Closes #2836

* Update website/docs/docs.md

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

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-01 14:06:02 +03:00
Sam Zhou
93b35afe95
feat(v2): Allow swizzling prism-include-languages in theme-classic (#2841)
* feat(v2): Allow swizzling prism-include-languages in theme-classic

* Add docs

* Improve docs
2020-05-31 14:41:16 +08:00
Koki Nishihara
ce4b0187aa
docs(v2): Update ZEIT to Vercel (#2842)
docs: update ZEIT to Vercel
2020-05-30 13:35:22 +08:00
Sébastien Lorber
768ed7368b
Merge branch 'master' into feature/client-side-redirects 2020-05-28 16:11:58 +02:00
Joe Previte
07b9e9cd62
feat(v2): expanded sidebar categories by default (#2682)
* feat: update sidebar categ to  take collapsed prop

* feat: add extra sidebars collapsed test

* fix: only mutate item.collapsed if necessary

* feat: update docs for SidebarItemCategory

* fix: update snapshots

* fix: update json to match new sidebar schema

* fix: update last snapshot

* refactor: check if item should be expanded

* docs: update sidebar categories section

* refactor: use new collpased on docusaurus

* feat: only highlight category for active page

* fix: check for window

* refactor: use ExecutionEnviornment

* refactor: make isCategoryOfActivePage pure

* fix: rename docs to docs-introduction in sidebars

* Update docs.md

* misc: remove setting for every sidebar

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-05-28 13:17:19 +08:00
Sam Zhou
33b60c6ba4
fix(v2): Consistently use 10.15.1 as the minimum required node version (#2819) 2020-05-27 23:18:48 +08:00
slorber
362573a391 Merge branch 'master' into feature/client-side-redirects 2020-05-27 16:51:04 +02:00
Alexey Pyltsyn
082c6212cb
feat(v2): allow deploy without building website (#2770)
* feat(v2): allow deploy without building website

* Update cli.md
2020-05-27 22:34:41 +08:00
slorber
d6afb44082 add doc for @docusaurus/plugin-client-redirects 2020-05-27 16:14:18 +02:00
Alexey Pyltsyn
2105700fb7
refactor(v2): various tweaks to website (#2816) 2020-05-27 20:56:59 +08:00
Alexey Pyltsyn
4cc36a535e
docs(v2): add trailing slash to external links (#2801) 2020-05-24 19:46:23 +08:00
Yangshun Tay
2dbd0488d7 docs(v2): document beforeDefaultRemarkPlugins and beforeDefaultRehypePlugins 2020-05-23 06:12:24 +08:00
Sam Zhou
1503943e3f
fix(v2): Use require.resolve to resolve plugin path in presets (#2794) 2020-05-23 04:57:02 +08:00
Muhammad Ali
e6cdeba603
docs(v2): add articles section to resources page (#2781) 2020-05-22 11:26:29 +08:00
Alexey Pyltsyn
7448501c7c
refactor(v2): make external links more secure (#2783) 2020-05-22 11:18:27 +08:00
Alexey Pyltsyn
0dc0c35ec8 docs(v2): misc update 2020-05-20 11:41:39 +03:00
Alexey Pyltsyn
fc161b8455
docs(v2): various improvements (#2768) 2020-05-18 11:37:53 +08:00