3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-03 04:07:32 +02:00
Code Issues Projects Releases Packages Wiki Activity
2619 commits 47 branches 176 tags 878 MiB
Commit graph

270 commits

Author SHA1 Message Date
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
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
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
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
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
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
Alexey Pyltsyn
8e24454154
feat(v2): allow import SVG images (#2764) 2020-05-18 11:18:02 +08:00
Artem Kovalov
6db5e8dff8
docs(v2): add deployment workflow manual for GitHub Actions (#2670) 
* docs: add deployment workflow manual for GitHub Actions

Steps to build and deploy Docusaurus with GitHub Actions

* docs(v2): improve formatting

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2020-05-18 11:07:48 +08:00
Fanny
d145f03ea8
refactor(v2): change the label for docs introduction (#2716) 
* change the label for docs introduction

* change file id

* refactor(v2): change name
 2020-05-17 19:29:57 +08:00
Ben Gubler
daafd2f0cc
feat(v2): allow activeBaseTest in NavLink (#2690) 
* Update documentation, add support for activeBaseTest

* Implicit else

* Fix Regular Expression capitalization

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

* Refactor isActive to ternary function, rename activeBaseTest to activeBaseRegex

* Update website/docs/theme-classic.md

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

* Fix typo

* Update website/docs/theme-classic.md

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

* Update theme-classic.md

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2020-05-17 19:23:32 +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
Fanny
3a2f150093
docs(v2): change fanny's description (#2757) 
* feat(v2): change fanny's description

* Update team.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
 2020-05-17 12:37:45 +08:00
Rajiv Singh
78add75057
docs(v2): fix typo in deployment (#2755) 2020-05-16 15:03:27 +08:00
Sébastien Lorber
9c94dd7c86
docs(v2): typo in creating page (#2753) 2020-05-16 01:16:05 +08:00
Yangshun Tay
c117a6fe79 docs(v2): update team page 2020-05-14 13:52:01 +08:00
Yangshun Tay
cfd76e3599 docs(v2): revise the introduction 2020-05-14 13:01:18 +08:00
Yangshun Tay
be7367b2f8
feat(v2): allow prepending of baseUrl to href in navbar and footer (#2746) 2020-05-14 11:47:28 +08:00
Jonny Nabors
afe70d973f
docs(v2): add new community plugin for dotenv support (#2730) 
* Add new community plugin for dotenv support

Adds a link to a new community plugin that introduces support for environment variables managed in `.env` files.

* Update resources.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
 2020-05-10 21:01:27 +08:00
Alexey Pyltsyn
df815db031 docs(v2): fix correct route base path for docs-only mode 2020-05-02 23:58:56 +03:00
Marco Moretti
5761835ae8
docs(v2): replace word append with prepend to describe useBaseUrl hook (#2707) 
* [doc] Replace word append with prepand to describe useBaseUrl hook

* [doc] Replace word append with prepend to describe useBaseUrl hook

* [doc] Replace append for all document versions
 2020-05-02 03:05:51 +08:00
Alexey Pyltsyn
52b20826fd docs(v2): add note about IE11 2020-04-30 11:06:19 +03:00
Alexey Pyltsyn
6190bf79a1 docs(v2): add note about IE11 2020-04-30 10:59:58 +03:00
Alexey Pyltsyn
d41f8ca1a9 docs(v2): various improvements 2020-04-28 17:44:06 +03:00
Alexey Pyltsyn
f8f6478c36 docs(v2): fix correct value for blog-only mode 2020-04-28 09:19:46 +03:00
Joe Previte
7caf7de417
docs: add swizzle example (#2680) 2020-04-28 10:53:45 +08:00
Alexey Pyltsyn
c0e531e5d9
feat(v2): add ability to specify CSS class for navbar item (#2660) 
* feat(v2): add ability to specify CSS class for navbar item

* Fix linting issues
 2020-04-27 02:21:36 +08:00
Alexey Pyltsyn
af89a92628
feat(v2): add fallback to BrowserOnly component (#2665) 
* feat(v2): add fallback to BrowserOnly component

* Update BrowserOnly.tsx

* Update docusaurus-core.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
 2020-04-26 20:39:34 +08:00
Sylvain Pace
1471a6eb3a
docs(v2): add mention that appID is optional (#2659) 2020-04-25 19:00:01 +03:00
Alexey Pyltsyn
510bec6532
Revert "feat(v2): add option to toggle sidebar category open by default (#2613)" (#2644) 
This reverts commit 1863a3c805.
 2020-04-22 18:50:18 +03:00
Joe Previte
1863a3c805
feat(v2): add option to toggle sidebar category open by default (#2613) 
* 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
 2020-04-22 20:31:10 +08:00
Tom Brien
852b5e8f13
feat(v2): add CLI option for polling (#2630) 
* Add CLI option to polling

Some environments (specifically docker containers) can have issues with file watching for live reloads. [Webpack Dev Server provides a polling alternative](https://webpack.js.org/configuration/watch/#watchoptionspoll) option for this

* Update docusaurus.js

* Update cli.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
 2020-04-20 10:49:43 +08:00
Alexey Pyltsyn
14f4ef875a
feat(v2): add ability set dark mode by default (#2597) 
* feat(v2): add ability set dark mode by default

* s/forceDarkMode/defaultDarkMode

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
 2020-04-17 19:19:55 +08:00
Yangshun Tay
2f2e3cd99d docs(v2): fix doc changes in #2606 2020-04-15 02:38:55 +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
Jay Lees
ad425b2652
docs(v2): remove duplicated package.json in installation directory structure (#2596) 2020-04-13 17:33:40 +08:00