Joshua Chen
3cb99124de
feat(content-docs): allow SEO metadata for category index pages ( #6239 )
2022-01-06 11:31:01 +01:00
Sébastien Lorber
cfae5d0933
feat(content-docs): sidebar category linking to document or auto-generated index page ( #5830 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Armano <armano2@users.noreply.github.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-12-03 14:44:59 +01:00
Joshua Chen
4478dd9659
docs: make API sidebar partially autogenerated ( #5917 )
...
* docs: make API sidebar autogenerated
* fix paths
2021-11-10 14:08:50 +08:00
Swalah Amani
c541e2d83c
misc: replace all "Metadatas" with "Metadata" ( #5871 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-09 19:46:10 +01:00
Joshua Chen
e0127c66be
chore(website): enable eslint in website ( #5889 )
...
* chore: enable eslint in website
* Fixes
* prettier users
2021-11-06 19:04:45 +08:00
Devtato
4922764095
docs: create SEO documentation page ( #5759 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-04 12:57:27 +01:00
Joshua Chen
8d92e9bcf5
refactor(content-docs): refactor sidebars, Joi validation, generator rework, expose config types ( #5678 )
2021-10-14 14:38:26 +02:00
Sébastien Lorber
a0c2c52829
chore: remove unused Bootstrap theme ( #5634 )
...
* remove package
* remove bootstrap from doc
* remove bootstrap init template + examples
* remove bootstrap preset
* remaining bootstrap refs
* update lockfile
2021-10-01 17:44:34 +02:00
Sébastien Lorber
a2ab4d33c8
feat: Markdown page-specific head metadatas ( #5330 )
...
* Markdown page-specific head metadatas
* ensure mdxType attribute is not added to the final markup
* polish doc
* Update packages/docusaurus-theme-classic/src/theme/MDXComponents/index.tsx
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
* fix eslint annoying rule error
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-08-11 11:39:01 +02:00
Sébastien Lorber
700a82aefe
feat: multiple playground choices ( #5207 )
...
* poc of using netlify functions for playground redirections
* push
* cleanup
* restore files
* fix netlify functions?
* fix netlify functions?
* implement serverless functions for playgrounds with persistent cookie
* move new.docusaurus.io to monorepo packages
* move new.docusaurus.io to monorepo packages
* lockfile
* push
* catch-all redirect
* Translate/Interpolate: add better error message if not used correctly
* Add /docs/playground page
* Add some additional doc
2021-07-22 21:10:36 +02:00
Pranab Das
6d184a3e3d
docs(v2): New doc page for math equations ( #4821 )
...
* New doc page for math equations
* improve math equations doc
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-06-02 14:55:50 +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
Joshua Chen
bfce849467
docs(v2): add browsers support documentation ( #4758 )
...
* Add browsers support documentation
* Remove explicit link
* Fix highlighted lines
* Better wording
* Address suggestions
2021-05-11 11:03:05 +02:00
besemuna
9715048f79
feat(v2): provide doc sidebar_label through sidebars.js ( #4500 )
...
* feat : update SidebarItemDoc type
* feat : update assertIsDoc
* feat : allow configuring title from sidebar.js
* feat : add docs
* docs : refactor i18n docs to use label in sidebar.js
* test : add test
* Update website/docs/guides/docs/sidebar.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
* docs : remove backported docs
Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com>
Co-authored-by: Javid <singularity.javid@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-03-26 15:11:21 +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
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
d5d6e2fba2
docs(v2): Add documentation for docs multi-instance support ( #3978 )
...
* Add documentation for docs multi-instance support
* Add documentation for docs multi-instance support
2020-12-30 19:41:42 +01:00
Sébastien Lorber
d99d53a236
docs(v2): Reorganize/split the guides doc sections ( #3975 )
...
* docs reorg
* refactor docs/markdown features section
* fix broken links after docs refactor
2020-12-30 17:03:25 +01:00
Arthur
109a4a7bbe
docs(v2): Move sidebar content to its own page ( #3899 )
...
* Move sidebar content to its own page
* Update website/docs/sidebar.md
* Fix merge conflict
* Fix note
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-12-11 17:02:32 +01:00
Sébastien Lorber
8f47babb46
docs(v2): Docs refactoring and reorganization ( #3831 )
...
* stable refactor of plugins api documentation
* plugins sidebar not collapsed by default as small?
* theme docs reorg
* Refactor migration guide doc
* fix broken link
2020-11-30 14:07:08 +01:00
Sébastien Lorber
9ba28a378f
feat(v2): doc navbar item type ( #3539 )
...
* provide DocNavbarItem type
* update snapshots
* Fix Docusaurus tabs CSS
* revert navbar tabs css/style changes, instead apply simple navbar__link--active class + make it configurable
* Update website/docs/theme-classic.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
* add dropdownActiveClassDisabled option
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-10-07 14:42:24 +03:00
Sébastien Lorber
59f705ee66
feat(v2): blog + docs multi-instance plugins ( #3204 )
...
* stable createData namespacing + second-blog dogfooding
* Docs: support multi-instance + make community docs a separate instance
* tests: add 2nd docs instance to versioned site
* fix docs version cli tests
* fix docs versioning cli
* typo
* team: add link to my site
* better extendCli integration
* fix metadata tests
* tests for versioned site with second docs instance
* move some validation code to utils-validation
* fix missing dependency
* fix bad compiled output due to importing constants in ./client folder
* make docs tests easier to maintain
* refactors
* prevent lodash imports in client bundle
* redirect old community docs to new urls
2020-08-05 18:27:55 +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
2020-07-31 21:14:49 +02:00
Teik Jun
a9109fba7b
docs(v2): add documentation for migration command ( #3026 )
...
* docs(v2): add docs for migration command
* docs(v2): fix admonitions
* docs(v2): make minor changes to instructions
* docs(v2): add information about option flags
* docs(v2): put migration docs in guide folder
* fix(v2): fix broken links
* fix(v2): fix more broken links
* docs(v2): fix a broken link again
* fix(v2): rerun github action
* Update website/docs/guides/migrating-from-v1-to-v2.md
* Update website/docs/guides/migrating-from-v1-to-v2.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-07-24 15:15:26 +02:00
Sébastien Lorber
f4434b2e42
feat(v2): absolute slugs and slug resolution system ( #3084 )
...
* rework slug to allow absolute slugs and slug resolution
* add slug metadata tests
* refactor docs metadata test + fix slug bugs
* fix tests
* fix docs tests failing due to randomness + update snapshot
* add test for addLeadingSlash
2020-07-21 18:26:30 +02:00
Sam Zhou
ec3c281952
docs(v2): Document TypeScript support ( #2997 )
2020-06-26 12:09:21 +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
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
Yangshun Tay
c1ef488115
docs(v2): add community pages ( #2545 )
...
* docs(v2): add community pages
* misc fixes
2020-04-06 01:10:22 +08:00
Yangshun Tay
8018a835e5
docs(v2): misc docs updates ( #2500 )
2020-04-02 12:29:39 +08:00
Sébastien Lorber
201c663318
feat(v2): allow nested sidebar category shorthand syntax ( #2444 )
...
* feat(v2): allow sidebar category shorthand syntax also for nested elements
* Update sidebars-category-shorthand.js
* Update sidebars-category-shorthand.js
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-03-26 00:59:51 +08:00
Yangshun Tay
6562a06944
docs(v2): add resources page ( #2401 )
...
* docs(v2): add resources
* titleize properly
2020-03-11 21:34:35 +08:00
Yangshun Tay
32c1a92b17
chore: yearless copyright headers for source code ( #2320 )
...
* chore: yearless copyright headers for source code
* update snapshots
2020-02-25 23:12:28 +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
160f6f53e0
docs(v2): add documentation on versioning ( #2038 )
...
* docs(v2): add documentation on versioning
* Proofread
* add section on using absolute import
2019-11-24 18:01:48 +07:00
Endi
64871b76e4
fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined ( #1909 )
...
* fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined
* nits
* Docs docs
* inaccuracy
* changelog
* nits
2019-10-30 08:51:53 +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
Yangshun Tay
510a44e824
misc(v2): docs updates
2019-10-12 12:02:16 -07:00
Endi
f671e6b437
docs(v2): simple migration guide from v1-v2 ( #1809 )
...
* docs(v2): simple migration guide from v1-v2
* fix wrong info
* add gitignore section
* proofread migration guide
* typo
* publish dir
* proofread
2019-10-06 09:29:47 +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
Wei Gao
f2864e0a91
docs(v2): analytics ( #1678 )
...
* docs(v2): analytics
* docs(v2): rework analytics docs
* fix broken link
2019-07-23 14:31:59 +08:00
Wei Gao
2a1eb365fd
docs(v2): SEO ( #1677 )
...
* docs(v2): SEO
* docs(v2): add section on customized SEO
* remove unnecessary comment
* docs(v2): separate SEO doc and fix typos
2019-07-21 00:03:05 +08: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
22ed720faa
docs(v2): revise "writing docs" ( #1561 )
...
* Revise doc on writing docs
* More work on docs doc
* misc(v2): tweak docs
* misc(v2): fix typo
2019-06-05 13:45:40 -07: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
Endi
404983c32b
docs(v2): install, create pages, docs, deploy ( #1522 )
...
* docs(v2): install, create pages, docs, deploy
* docs(v2): Docs review changes for installation, create pages, docs,
deploy
* docs(v2): more docs!
2019-05-29 01:08:06 -07:00
endiliey
4a4bf43e5d
chore(v2): fix typo
2019-05-15 19:35:14 +08:00
endiliey
badb067b4b
test(v2): test different type of sidebar item
2019-05-15 19:16:28 +08:00
