Commit graph

53 commits

Author SHA1 Message Date
Sébastien Lorber
de972142a8
chore: backport retro compatible commits for the Docusaurus v2.2 release (#8264)
Co-authored-by: Jan Peer Stoecklmair <jan.peer.stoecklmair@dynatrace.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: LittleboyHarry <littleboyharry@qq.com>
Co-authored-by: Mikey O'Toole <mikey@homotechsual.dev>
Co-authored-by: Jan Peer Stöcklmair <jan.oster94@gmail.com>
Co-authored-by: Nguyễn Thành Nam <namnguyenthanh.work@gmail.com>
Co-authored-by: Sanjaiyan Parthipan <parthipankalayini@gmail.com>
Co-authored-by: Ramazan SANCAR <ramazansancar4545@gmail.com>
Co-authored-by: mturoci <64769322+mturoci@users.noreply.github.com>
Co-authored-by: Adnan Hashmi <56730784+adnanhashmi09@users.noreply.github.com>
Co-authored-by: Pranav Joglekar <pranav2000joglekar@gmail.com>
Co-authored-by: forgeRW <20483211+forgeRW@users.noreply.github.com>
Co-authored-by: Masahiko Hara <pasora@sfc.wide.ad.jp>
Co-authored-by: Johan Fagerberg <johanringmann@gmail.com>
Co-authored-by: John Reilly <johnny_reilly@hotmail.com>
Co-authored-by: Sam Wall <oss@samuelwall.co.uk>
Co-authored-by: Jeferson S. Brito <30840709+jeferson-sb@users.noreply.github.com>
Co-authored-by: evan <evanmccarthy@outlook.com>
Co-authored-by: Xabier Lahuerta Vazquez <xlahuerta@protonmail.com>
Co-authored-by: Forresst <forresst17@gmail.com>
Co-authored-by: Shanmughapriyan S <priyanshan03@gmail.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2022-10-29 15:13:42 +02:00
Alexander Nestorov
b503523f66
feat(core): allow opting out of HTML minification (#7581) 2022-06-15 18:41:03 +02:00
Joshua Chen
e12a2efaeb
docs: normalize capitalization (#7619) 2022-06-15 13:04:33 +08:00
Joshua Chen
ab566ecce3
docs: remove useless front matter (#7518) 2022-05-28 19:07:45 +08:00
James
35e63515e6
feat: make docusaurus serve automatically open in browser (#7500)
* feat: add automatic url open to npm run serve

* fix

* adding ci check

* add docs

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-05-27 10:45:53 +02:00
Lane Goolsby
5aaa33fc61
feat: add --no-minify flag to docusaurus start (#7452)
* feat: Adding --no-minify flag to start

* Undoing the changes to old docs

Co-authored-by: Lane Goolsby <lanegoolsby@rocketmortgage.com>
2022-05-20 12:50:17 +08:00
Joshua Chen
9fd5d62340
docs: enhance docs about Markdown TOC and metadata (#7278)
* docs: multiple documentation improvements

* fix

* fix
2022-04-30 21:30:14 +08:00
Begula
63caeb6073
docs(cli): add info about development on github codespaces (#6883)
* docs: add info about development on github codespaces

* docs: move from installation to cli

* docs: fix grammar

* Update cli.md

* add word

* Update cli.md

* Update cli.md

* format

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-10 11:22:21 +08:00
Joshua Chen
39b66d82ef
feat(core): rework swizzle CLI (#6243)
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-25 14:13:15 +01:00
Joshua Chen
c3370be64d
refactor: make MDX export a flat TOC list instead of tree (#6729) 2022-02-23 15:12:04 +01:00
Joshua Chen
2553f1fb5a
refactor: improve internal typing (#6507)
* refactor: improve internal typing

* fix

* fix test
2022-01-29 22:58:40 +08:00
Joshua Chen
73ee356949
docs: audit grammar issues (#6203)
* docs: audit grammar mistakes

* fix code block language

* revert change

* let's get another
2021-12-27 19:34:04 +08:00
Joshua Chen
2398943c17
feat(core): write-heading-ids options maintainCasing, overwrite (#5740) 2021-10-21 12:33:52 +02:00
Sébastien Lorber
8bdb3da233
feat(v2): generalize usage of _ prefix convention to exclude content files/folders (#5173)
* create a swizzleWarning partial for shared text

* Generalize usage of _ prefix convention to exclude content files/folders

* add api doc

* MDX loader should not expect metadata/frontmatter on MDX partial files
2021-07-15 13:21:41 +02:00
Alexey Pyltsyn
d7e4e422a2
docs(v2): minor tweaks (#4981) 2021-06-16 11:04:40 +02:00
Sébastien Lorber
fe6492aa87
docs(v2): Improve intro doc (#4770)
* Intro documentation refactoring

* useless images

* improve the intro doc
2021-05-12 14:40:35 +02:00
duanwilliam
51031c1afd
docs(v2): fix run-on sentence (#4543)
* docs: fix run-on sentence

* Update cli.md

* Update cli.md

* Update cli.md

* Update cli.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-04-01 19:59:39 +02:00
Armano
ea13c94cc2
feat(v2): read first heading as title and use it in front-matter (#4485)
* feat(v2): read first heading as title and pass it to front-matter

* fix(v2): always trim content after extracting front-matter

* fix(v2): remove heading from rss and keep duplicate heading

* fix(v2): rollback some unnecessary comment changes

* test(v2): add unit tests to blog

* test(v2): add unit tests to docs

* test(v2): correct issue on windows

* test(v2): add additional test cases
2021-03-23 18:07:21 +01:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Alexey Pyltsyn
96e7fcef25
feat(v2): add ability to set custom heading id (#4222)
* feat(v2): add ability to set custom heading id

* Add cli command

* Fix slugger

* write-heading-ids doc + add in commands/templates

* refactor + add tests for writeHeadingIds

* polish writeHeadingIds

* polish writeHeadingIds

* remove i18n goals todo section as the  remaining items are quite abstract/useless

* fix edge case with 2 md links in heading

* extract parseMarkdownHeadingId helper function

* refactor using the shared parseMarkdownHeadingId utility fn

* change logic of edge case

* Handle edge case

* Document explicit ids feature

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-05 19:36:14 +01:00
Long Ho
f46adffa17
feat(v2): add --config option to CLI (#4308)
* feat: add --config & --generated-files-dir option to CLI

* revert --generated-files-dir option + some refactors

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-02 17:34:23 +01:00
Massoud Maboudi
704df6864e
docs(v2): improve cli docs (#4259)
* added more details about --danger flag for swizzle

* added referencing to blog posts

* improved the docs for swizzling.

* added new Farsi/Persian translation

* Update website/docs/cli.md

* Update website/docs/cli.md

* Update website/docs/using-themes.md

* PR cleanup

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-22 20:38:05 +01:00
Sébastien Lorber
a8ee7fd3e8
docs(v2): i18n doc + polish (#4014)
* add some initial i18n doc

* i18n doc progress

* i18n tutorial progress

* i18n tutorial progress

* polish Crowdin docs

* i18n sidebar in guides

* polish crowdin doc

* update Crowdin doc a bit

* fix annoying relative link to global site resource in template (breaks i18n tutorial)

* template: use simpler export for homepage

* add markdown page example

* rename mdx.md to interactiveDoc.mdx

* update bootstrap/facebook templates too

* sync init template package scripts

* add slug frontmatter doc

* improve i18n doc

* complete i18n doc

* temporarily enable the localeDropdown

* doc typo

* improve the i18n doc

* Add Git i18n doc

* add missing "--" for npm run options (unfortunately they don't get stripped by npm2yarn, and are required foor npm)

* improve a bit the Crowdin doc
2021-01-19 17:26:31 +01:00
Sébastien Lorber
41ef333e47
feat(v2): inline table-of-contents + refactor TOC (#3904)
* Add TOCInline theme component

* Add TOCInline theme component doc + migration guide

* remove useless getPathsToWatch on classic theme

* rename rightToc to toc

* add temp theme-bootstrap TOCInline comp to fix build issue
2020-12-11 16:30:53 +01:00
Sébastien Lorber
4fbece2383
docs(v2): remove @next tags + minor docs changes (#3783) 2020-11-19 12:48:18 +01:00
Alexey Pyltsyn
487a9f98e4
feat(v2): introduce new minification of CSS bundle (#3716)
* feat(v2): optimize CSS bundle

* Move to separate preset

* Move custom scrollbar styles to separate class

* Cleanup styles

* Remove unactual styles

* Various CSS optimizations, cleanup styles for NProgress

* Add ability to back to old way of minifying CSS

* chore(v2): downgrade babel-plugin-dynamic-import-node to 2.3.0

* Use env var for back to simple CSS minifier

* remove unnecessary typing [skip-ci]

* Remove missing dep

* Update website/docs/cli.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-11-13 14:06:24 +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
Thakur Karthik
92884431d1
feat(v2): add support for key,cert in https (#3594)
* fix: add support for key,cert in https

* docs: add steps for using https with docusaurus

* improve https certs docs

* typo

* local https: add mkcert -install step

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2020-10-26 17:28:12 +01:00
Sébastien Lorber
44535f7555
fix(v2): docusaurus start --poll 500 should work + better config load failure error (#3622)
* start --poll 500 should be accepted + better error message when siteDir is wrongly passed as a cli arg and lead to config loading failure

* docusaurus start --poll 500  option should also be used for chokidar

* config error message: relative path for reliable tests

* update snapshot

* document start --poll [interval]
2020-10-21 19:16:53 +02:00
Alexey Pyltsyn
9134b1396b
docs: various fixes and improvements (#3546) 2020-10-07 12:39:47 +02:00
Henry Vélez
cc31567459
feat(v2): new docusaurus clear command (#3446)
* feat: new docusaurus clear command

* Update packages/docusaurus/bin/docusaurus.js

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

* docs: new docusaurus clear command

* fix doc

* update monorepo clear cmd

* make clear async function wait for deletes to complete + factorize a bit

* prettier fix

* better clear docs

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-09-28 16:33:35 +02:00
Tim Gates
8bed33b81f
docs(v2): fix simple typo, localy -> locally (#3480)
There is a small typo in website/docs/cli.md, website/docs/deployment.md, website/versioned_docs/version-2.0.0-alpha.60/cli.md, website/versioned_docs/version-2.0.0-alpha.60/deployment.md, website/versioned_docs/version-2.0.0-alpha.61/cli.md, website/versioned_docs/version-2.0.0-alpha.61/deployment.md, website/versioned_docs/version-2.0.0-alpha.62/cli.md, website/versioned_docs/version-2.0.0-alpha.62/deployment.md, website/versioned_docs/version-2.0.0-alpha.63/cli.md, website/versioned_docs/version-2.0.0-alpha.63/deployment.md, website/versioned_docs/version-2.0.0-alpha.64/cli.md, website/versioned_docs/version-2.0.0-alpha.64/deployment.md.

Should read `locally` rather than `localy`.
2020-09-23 22:50:06 +03:00
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
ef9314e5a4
feat(v2): update swizzle command to suggest component/theme (#3021)
* update swizzle command

* change messages

* fix formatting

* add docs

* fix component lisiting

* allow themes to provide a list for safe swizzle components

* support both commanjs and ES exports

* fix debug plugin doesn't swizzle

* add dos

* remove unsed file

* fix docs plugin not swizzle properly

* fix console.log

* use new validate

* fix linting

* use config options for plugin

* rerun test

* fix type

* add a comment

* Update packages/docusaurus/src/commands/swizzle.ts

* Update packages/docusaurus/src/commands/swizzle.ts

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-08-06 13:53:03 +02:00
Anshul Goyal
a51a56ec42
feat(v2): add support for serve command (#3080)
* add support for serve command

* add serve to init

* use existing choosePort function

* add --host

* add more docs

* add docs to deployment
2020-07-20 19:00:37 +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
Alexey Pyltsyn
fc161b8455
docs(v2): various improvements (#2768) 2020-05-18 11:37:53 +08:00
Joe Previte
7caf7de417
docs: add swizzle example (#2680) 2020-04-28 10:53:45 +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
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
Alexey Pyltsyn
fa2e263ce8
feat(v2): add ability to create unminimized bundles (#2474) 2020-03-29 23:32:26 +08:00
Alexey Pyltsyn
92f2c52034
docs(v2): mark that in dev server some features may not work (#2478) 2020-03-29 12:10:50 +08:00
Yangshun Tay
36ea74504e
docs(v2): use codeblock title syntax instead of comments (#2473) 2020-03-29 01:08:50 +08:00
ZachJW34
ce45413804
feat(v2): add custom output directory to build (#2417) 2020-03-19 23:52:26 +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
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
29ce98c63a docs(v2): misc updates 2019-11-17 05:44:21 -08:00
Alexey Pyltsyn
e408d72d26 feat(v2): add ability disable to open page in browser when start command (#1856)
* feat(v2): add ability disable to open page in browser when start command

* Replace disable-open-browser with no-open

* Fixes
2019-10-19 11:17:34 +07:00
Cole
0568ad4992 feat: allow different host through CLI flag (#1475)
* feat(core): use 0.0.0.0 for livereload address

* test(core): update server tests

* feat(cli): add host by command line flag

* test: revert test changes

* fix(core): update server to use custom host if supplied

* refactor: nits
2019-05-20 23:31:41 +07:00