1a5e33c717
refactor(pwa): remove reloadPopup option in favor of swizzling ( #7422 )
...
* refactor(pwa): remove reloadPopup option in favor of swizzling
* restore code splitting
* add deprecation
2022-05-27 20:32:22 +08:00
4f97c7b52c
docs: link every reference of types in API table to the type definition ( #7497 )
...
* dogfood fix
* feat: links for plugin types
* better syntax
* little refactor
* use code title
* complete the rest
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-05-26 15:06:36 +08:00
cd21a31005
test: strengthen internal types ( #7488 )
2022-05-25 15:38:44 +08:00
5bed55aeda
refactor(types): JSDoc for docusaurus config fields ( #7291 )
2022-05-03 13:57:19 +08:00
b747143982
docs: update gtag docs to reflect what a GA4 tag looks like ( #7252 )
2022-04-28 09:05:25 +08:00
5fb0a2e274
feat(content-docs): draft docs excluded from build & sidebars ( #6457 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-13 18:02:05 +02:00
103ea04661
feat(sitemap): add ignorePatterns option ( #6979 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-06 15:44:07 +02:00
2bcac29cd4
refactor(content-docs): deduplicate types, JSDoc for some APIs ( #7027 )
...
* refactor(content-docs): deduplicate types, JSDoc for some APIs
* little refactor
2022-03-27 12:57:15 +08:00
b5ceead3b2
feat(content-docs): autogenerate category with linked doc metadata as fallback ( #6859 )
2022-03-25 15:23:11 +01:00
8d1c1954c1
refactor(content-blog): clean up type definitions; in-code documentation ( #6922 )
...
* refactor(content-blog): clean up type definitions; in-code documentation
* add doc
2022-03-16 19:36:57 +08:00
3629b5ab39
feat(docs,theme-classic): docs breadcrumbs ( #6517 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-16 19:02:58 +01:00
3fd99ad8d4
feat(content-blog): allow customizing blog archive component through option ( #6603 )
...
* feat(content-blog): allow customizing blog archive component through option
* fix
2022-02-04 18:56:09 +08:00
1ca07f8466
refactor(content-docs): read category metadata files before autogenerating ( #6586 )
...
* refactor(content-docs): read category metadata files before autogenerating
* fix tests
* fix Windows...
* warn user when behavior is undetermined
* oops
* fix typo
2022-02-03 16:16:19 +08:00
ade486d079
docs: mention where to find the sitemap ( #6492 )
...
* Added the sitemap url
So that users know where to locate their sitemaps
* Update plugin-sitemap.md
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-28 17:11:09 +08:00
24a895fbc5
feat(content-docs): expose isCategoryIndex matcher to customize conventions ( #6451 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-01-26 17:58:52 +01:00
59022c5eea
docs: add advanced guides ( #6296 )
...
* docs: add advanced guides
* complete
* fix link
* Create architecture
* use png
* explanations
* more text
* process.env.NODE_ENV
* typo
* Add image zoom
* nit
* nit
* reorganize
* fix links
* fix links
* reorganize
* elaborate on presets
* fix
* routing docs
* ssr section
* more content
* complete SSR guide
* pathname://
* improvements
* document executionenvironment
* reformat
* final tweaks!
* avoid slug
* oops
2022-01-25 11:29:18 +08:00
d506bca12d
feat(content-blog): allow disabling generating archive ( #6415 )
2022-01-20 14:52:19 +01:00
06a8cdcb0f
docs: elaborate on doc versioning ( #6280 )
...
* docs: elaborate on doc versioning
* Complete
* fix
2022-01-07 14:28:48 +08:00
a03788374e
fix(website): fix config-tabs breaking after translation ( #6275 )
...
* fix(website): fix config-tabs breaking after translation
* more robust
2022-01-06 19:31:58 +08:00
8fe1ddf46a
feat(sitemap): remove trailingSlash option; respect noIndex config ( #6248 )
2022-01-05 17:56:17 +01:00
5132ecdeee
docs: normalize plugin API documentation ( #6193 )
...
* docs: normalize plugin API documentation
* Revert change
* Use remark plugin
* edits
* edit again
* Fixes
2021-12-28 21:23:27 +08:00
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
e1bff072fe
feat(ideal-image): new option disableInDev ( #6155 )
...
* feat(ideal-image): new option disableInDev
* Add docs
* Use import type
* More docs
2021-12-25 21:48:38 +08:00
a17deb6aa2
docs: remove mention of 'UA-' in gtag ( #6184 )
2021-12-24 17:21:31 +08:00
dedf5ace5f
docs: normalize usage of placeholders ( #6142 )
2021-12-21 14:56:29 +01:00
7e5f6bb805
feat(content-blog): support json feed ( #6126 )
...
* feat(content-blog): support json feed
* feat(content-blog): support json feed
* feat(content-blog): add json type to default feed options
* Refactors, docs, validation
* Fix test
* Ammend docs
* Add API doc
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-18 22:47:40 +08:00
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
ac88d979f1
refactor(ganalytics, gtag): move options out of themeConfig ( #5832 )
...
* refactor(ganalytics, gtag): move options out of themeConfig
* Forbid themeConfig options
* Add PR link
* Add key names to error message
* Fix?
* Doc updates
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-11-10 19:04:43 +08:00
ecce576bbc
docs: new APITable comp to render large tables ( #5891 )
2021-11-10 11:38:23 +01:00
4478dd9659
docs: make API sidebar partially autogenerated ( #5917 )
...
* docs: make API sidebar autogenerated
* fix paths
2021-11-10 14:08:50 +08:00
c541e2d83c
misc: replace all "Metadatas" with "Metadata" ( #5871 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-09 19:46:10 +01:00
1c024470e0
feat(content-blog): allow sorting posts in ascending order ( #5787 )
2021-11-09 18:25:43 +01:00
2e85848487
docs: Minor update to grammar in plugins overview page ( #5771 )
2021-10-27 13:06:05 +02:00
9ad6de2b85
feat(content-blog): new readingTime plugin option ( #5702 )
2021-10-21 15:26:10 +02:00
3127f12654
feat(content-docs): new front matter options to customize pagination ( #5705 )
2021-10-21 12:27:57 +02:00
eaacb0e98a
feat(theme-classic, plugin-docs): sidebar item level-specific className + allow customization ( #5642 )
...
* Initial work
* Complete function
* Avoid duplication
* More dedupe
* Make everything constants
* Change casing & docs
2021-10-07 16:59:02 +02:00
3f1f8255a2
chore: upgrade Prettier + regenerate lock file ( #5611 )
...
* Bump deps
* Run prettier
* Format docs
* Minor refactor
* Collapse objects
* Fix type
* Update lock file
2021-09-30 12:54:17 +02:00
c86dfbda61
feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) ( #5578 )
...
* feat: add all TOC levels to MDX loader
* feat: add theme-level config for heading depth
* test: add remark MDX loader test
* fix: limit maxDepth validation to H2 - H6
* refactor: set default `maxDepth` using `joi`
* refactor: `maxDepth` -> `maxHeadingLevel
* refactor: invert underlying TOC depth API
* refactor: make TOC algorithm level-aware
* feat: add support for per-doc TOC heading levels
* feat: support document-level heading levels for blog
* fix: correct validation for toc level frontmatter
* fix: ensure TOC doesn't generate redundant DOM
* perf: simpler TOC heading search alg
* docs: document heading level props for `TOCInline`
* Update website/docs/guides/markdown-features/markdown-features-inline-toc.mdx
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
* docs: fix docs (again)
* create dedicated test file for heading searching logic: exhaustive tests will be simpler to write
* toc search: add real-world test
* fix test
* add dogfooding tests for toc min/max
* add test for min/max toc frontmatter
* reverse min/max order
* add theme minHeadingLevel + tests
* simpler TOC rendering logic
* simplify TOC implementation (temp, WIP)
* reverse unnatural order for minHeadingLevel/maxHeadingLevel
* add TOC dogfooding tests to all content plugins
* expose toc min/max heading level frontmatter to all 3 content plugins
* refactor blogLayout: accept toc ReactElement directly
* move toc utils to theme-common
* add tests for filterTOC
* create new generic TOCItems component
* useless css file copied
* fix toc highlighting className conflicts
* update doc
* fix types
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-29 11:19:11 +02:00
29e06d0677
feat: make tags route path configurable ( #5545 )
2021-09-21 19:19:18 +02:00
02eee61aa5
docs: improve escape pipe in Markdown tables ( #5539 )
...
* Test escape pipe in Markdown table
From a remark on Crowdin:
> The value for the Type entry in the plugin-content-blog page is strange.
> In English documents, the Type item value is normally displayed.
> ex) editUrl: string | EditUrlFunction
> However, in French documentation, the Type item value is shown as an unknown code.
> ex) editUrl:!!crwdBlockTags_249_sgaTkcolBdwrc!!
> ex) blogSidebarCount: !!crwdBlockTags_250_sgaTkcolBdwrc!!
This is a test to see if the other way to escape a pipe in a markdown table could solve the problem.
* Fix all docs to replace | by \|
* Keep `code`
* Apply suggestions from code review
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-09-08 14:58:48 +03:00
cb8718a1e3
feat: adds blog archive route ( #5428 )
...
* [feature] adds blog archive route
* Update plugin-content-blog.md
* fix TS issues + minor refactors
* remove useless css
* add translation apis
* add missing translations
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-02 17:35:13 +02:00
42e70e6d42
feat: new docs options: versions.{badge,className} ( #5454 )
...
* docs: add versions.{badge,className} options
* remove badge option test
2021-08-31 15:40:37 +02:00
493225a3c6
feat(plugin-blog): multi-authors support + authors.yml global configuration ( #5396 )
...
* Complete function
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* A lot of blank lines
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More lenient validation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove or
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Simpler logic
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Expand docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Better docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Dogfood
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More writeup
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move mergeAuthorMap to authors.ts
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Unbreak relative assets
* Update docs
* Clarify in docs
* simplify feed authors
* rename authorMap -> authorsMap
* mergeAuthorsMap -> getBlogPostAuthors
* website => 5 blog posts per page
* improve authors map file
* Extract new theme authors components + display in row
* add comment for meta array syntaxes
* blog => getPathsToWatch should watch authorsMap file
* remove useless v1 blog FBID frontmatter
* keep older frontmatter syntax for now
* revert blog frontmatter
* Better console message
* better blog authors frontmatter impl
* add multi authors to beta blog post + fix some authors margins
* fix React key
* Refactor: mdx loader should support a more flexible assets system (poc, not documented yet)
* better display of blog post authors: adapt layout to authors count + add line clamp
* smaller local image
* fix blog feed tests
* fix blog frontmatter tests + improve validation schema
* add more frontmatter tests
* add tests for getAuthorsMapFilePath
* tests for validateAuthorsMapFile
* add tests for readAuthorsMapFile
* test getAuthorsMap
* exhaustive tests for getBlogPostAuthors
* fix remaining tests
* missing blog plugin author tests
* fix windows tests
* improve blog multi-author's doc
* Use new format in init template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Improve error message
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* update feed snapshot
* blog authors: limit to 2 cols + fix margins for no authors
* minor doc improvements
* better init template blog posts, demonstrating Blog features
* replace the legacy blog author frontmatter in remaining places
* Prefer using clsx
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* cleanup getColClassName
* remove blog author name/title line-clamping
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-26 12:21:58 +02:00
8e1cde135c
feat: make blog config options and navbar versions dropdown label translatable ( #5371 )
...
* Translate versions dropdown label
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Make blog options tranlatable
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix names
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Rename functions
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Rename translations path
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update Chinese translations
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove space
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add jest test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix copyright typing
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update options
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-20 17:11:59 +02:00
f9c79cbd58
feat: doc tags (same as blog tags) ( #3646 )
...
* [v2] tags to doc, same as tags to blog - [IN PROGRESS]
- Addition of plugin-content-docs
- Addition of DocTagsListPage in `docusaurus-theme-classic`
! Error exists for this commit towards the theme aspect and help required.
Commit towards #3434
* docs: make tags list page work
* temp: disable onBrokenLinks
* theme bootstrap: create DocTagsListPage
* DocTagsPage added and functionality too
- individual doc tag page added to show docs for that specific tag
* Added all Docs Tags Link
* add some shared tag utils
* move tag tests to _dogfooding
* fix type
* fix some tests
* fix blog test
* refactor blog post tags handling
* better yaml tag examples
* better dogfood md files
* refactor and factorize theme tag components
* finish DocTagDocListPage
* Extract DocItemFooter + add inline tag list
* minor fix
* better typings
* fix versions.test.ts tests
* add tests for doc tags
* fix tests
* test toTagDocListProp
* move shared theme code to tagUtils
* Add new theme translation keys
* move common theme code to tagUtils + add tests
* update-code-translations should handle theme-common
* update french translation
* revert add translation
* fix pluralization problem in theme.docs.tagDocListPageTitle
* add theme component configuration options
* add more tags tests
* add documentation for docs tagging
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-19 10:31:15 +02:00
8341527fc9
refactor: rename Git master branch to main ( #5345 )
...
* Prepare to renaming master branch to main
* Update CONTRIBUTING.md
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json
* missing master -> main replaces
* useless char
* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required
* fix versioning page
* fix vercel links
* update deployment.mdx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
7d0272fe4d
feat(plugin-blog): allow `'ALL'` as `postsPerPage` option value ( #5354 )
...
* 'ALL' option
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Guard against zero posts
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove redundant code
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-17 13:07:18 +02:00
1257e99112
docs: try to make plugin/preset config less confusing ( #5313 )
2021-08-10 12:32:44 +02:00
cabb768473
feat: blog posts support /YYYY/MM/DD/blog-post/index.md pattern + blog frontmatter can reference relative images ( #5309 )
...
* POC of blog post folder
* add parseBlogFileName with tests + refactor and extract processBlogSourceFile in separate method
* improve blog date pattern doc + link from content plugin guides to API ref docs
* Some FrontMatter fields should be able to reference relative image assets, converted to Webpack require calls and exposed as frontMatterAssets
* remove log
2021-08-06 17:51:59 +02:00
c603056f66
docs: refactor API documentation ( #5219 )
...
* Refactor plugin-docs documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor theme-configuration
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor plugin-blog docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* plugin-pages
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Minor change
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Interchange table columns
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fixes
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Minor improvements
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix hash link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move blog front matter to API
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add more blog documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update blog.md
* Update blog.md
* Update blog.md
* Update website/docs/blog.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-04 16:35:17 +02:00
24156efcfb
feat: docs plugin options sidebarCollapsible + sidebarCollapsed ( #5203 )
...
* Add prop
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add `collapsible` option to sidebar item
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add eslint-ignore
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move new page
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Allow in autogenerated
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix tests
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move config options to plugin-docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Make non-collapsible items always expanded
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* docs versioning cli should receive a single options object
* Update cli.test.ts
* revert validateCategoryMetadataFile change
* remove theme usage of themeConfig.sidebarCollapsible
* better handling of sidebar item category inconsistencies + add warning message
* Update snapshot
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Handle plugin option inconsistencies
* improve doc for new sidebarCollapsible doc options
* remove warning in fixSidebarItemInconsistencies as it will be annoyed for versioned sites, as "collapsed" is already persisted in sidebar json files
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-07-23 14:24:36 +02:00
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
f14d8d2fdd
docs(v2): GIF format is not suported ( #5133 )
...
https://github.com/facebook/docusaurus/issues/2956
Please check the issue above.
GIF format is currently is not supported
2021-07-12 19:40:42 +02:00
f74e6c5107
docs(v2): clarify how to disable edit links entirely ( #5112 )
...
* docs: clarify how to disable edit links entirely
* Update website/docs/api/plugins/plugin-content-docs.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-05 12:38:10 +02:00
364051f232
feat(v2): docs version banner configuration option ( #5052 )
...
* refactor DocVersionBanner => versionMetadata prop should be forwarded instead of using "useActiveVersion" + global data
* docs version banner configuration
* add doc for versions.banner
* fix tests
* improve docs plugin option api doc
2021-06-24 18:04:16 +02:00
c96c3b5c39
docs(v2): fix incorrect anchor links in website ( #5021 )
...
* docs: fix anchor links for docusaurus write-translations
* docs: fix anchor links for docusaurus serve
2021-06-20 22:16:17 +03:00
32e76f1cc0
feat(v2): add docs pagination_label frontmatter ( #4982 )
...
* feat(v2): add docs pagination_label frontmatter
* feat(v2): add docs pagination_label frontmatter
* feat(v2): add docs pagination_label frontmatter
2021-06-16 12:03:46 +02:00
d7e4e422a2
docs(v2): minor tweaks ( #4981 )
2021-06-16 11:04:40 +02:00
af3640dca2
docs(v2): replace `diff` codeblocks with line highlight ( #4973 )
...
* Replace `diff` codeblocks with line highlight
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add line highlight
2021-06-16 10:29:05 +02:00
737f80a026
fix(v2): sidebar_label should be used to compute next/previous button labels ( #4970 )
...
* sidebar_label should be used to compute next/previous button texts, as documented.
* improve docs frontmatter doc
* use a little bit of destructuring
2021-06-15 12:04:29 +02:00
df8a900f9c
feat(v2): add trailingSlash config option ( #4908 )
...
* POC: add trailingSlash option
* integrate the preferFoldersOutput option of fork @slorber/static-site-generator-webpack-plugin
* Fix broken links when using trailing slash => using md links is more reliable
* fix TS issue
* minor polish
* fix doc page being sensitive to trailing slashes
* Add tests for applyTrailingSlash
* rename test files
* extract and test applyRouteTrailingSlash
* update snapshot
* add trailing slash config to serve command
* fix getSidebar() => still sensitive to trailing slash setting
* never apply trailing slash to an anchor link
* Add documentation for trailingSlash setting
2021-06-09 19:59:39 +02:00
57806798c5
fix(v2): fix contentTitle issues when markdown h1 title contains code blocks ( #4882 )
...
* attempt to fix contentTitle issues when markdown h1 title contains inline code blocks
* mention hide_title frontmatter only prevents frontmatter.title from being added in the dom (not a markdown # title in content)
* alwayss insert MainHeading under the div.markdown container for consistency
* ensure MainHeading has no useless id
* revert https://github.com/facebook/docusaurus/pull/4859 as it's now useless: docMeta.title contains the text/frontmatter title in priority over the contentTitle
* fix docs test after revert
* improve markdownParser and fix tests
* fix docs tests
* markdownParser: restore option to remove contentTitle (mostly for blog plugin)
* use removeContentTitle for blog
2021-06-03 17:45:19 +02:00
5fc5071882
docs(v2): specify google-analytics and gtag plugins ( #4703 )
...
Closes #4678
2021-05-04 16:46:07 +02:00
792f4ac6fb
feat(v2): allow user to customize/enhance the default sidebar items generator ( #4658 )
...
* allow and document how to wrap/enhance the default docusaurus sidebar items generator
* improve doc
* doc
* doc
2021-04-21 18:35:03 +02:00
c04e613ffe
feat(v2): docs, make numberPrefixParser configurable, better defaults, minor breaking-changes ( #4655 )
...
* make number prefix parsing logic configurable
* Make numberPrefixParser configurable + rename frontmatter + avoid parsing date/version patterns by default
* add more tests
* more test cases
2021-04-21 12:06:06 +02:00
db79d462ab
feat(v2): auto-generated sidebars, frontmatter-less sites ( #4582 )
...
* POC of autogenerated sidebars
* use combine-promises utility lib
* autogenerated sidebar poc working
* Revert "autogenerated sidebar poc working"
This reverts commit c81da980
2021-04-15 16:20:11 +02:00
78349480af
chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups ( #4490 )
...
* prepare v1-v2 domain switch
* rename v1 changelog as CHANGELOG-1.x.md
* switch v1/v2 changelogs
* Cleanup v2.docusaurus.io urls
* add netlify domain redirect
* remove circleci config
* remove another circle file
2021-03-22 20:57:49 +01:00
291a72fbae
docs(v2): use explicit heading IDs ( #4460 )
2021-03-19 11:00:41 +01:00
02cd5d343b
fix(v2): PWA issues + improve docs ( #4377 )
...
* debug pwa
* more debugging logs + attempt to upgrade workbox
* fix PWA ?
* fix PWA ?
* enable pwa debugging for deploy previews
* try to fix the app installed issue?
* try to fix appinstalled not firing
* try to add related applications to the PWA manifest
* attempt to fix related_applications
* attempt to fix related_applications
* attempt to fix related_applications
* improve PWA strategies
* improve PWA doc
* refactor/cleanup registerSw
* cleanup
2021-03-10 20:00:42 +01:00
1c7d423e0c
docs(v2): various improvements ( #4369 )
...
* docs(v2): various improvements
* Update blog.md
2021-03-09 14:59:32 +01:00
f13448d5e1
chore(v2): upgrade dependencies + require Node 12 ( #4223 )
...
* chore(v2): upgrade dependencies
* Set minimum Node.js version to 12.13
* Fix test
* Upgrade copy-text-to-clipboard
* Bump Node versions
* Update .nvmrc
* mark cacheTime as forbidded field
* Downgrade jest to v25.2.7
* Increase Node version for Windows CI
* Test fix
* Attempt to fix Windows CI
* Downgrade execa
* fix async test errors
* Upgrade execa
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-18 15:12:42 +01:00
ae988d0eb9
feat(v2): editUrl functions should receive md doc permalink ( #4232 )
2021-02-17 11:48:33 +01:00
219a4b7b8c
docs(v2): plugins docs typo fix ( #4141 )
2021-02-01 12:01:56 +01:00
be7b5dca78
feat(v2): editUrl function for advanced use-cases ( #4121 )
...
* EditUrl function
* normalize blog/docs regarding the editUrl feature + editUrl function
* editUrl fn => always inject posix style relative paths, make tests more reliable
(see also https://github.com/facebook/docusaurus/issues/4124 )
* fix editUrl on windows
2021-01-29 15:35:25 +01:00
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
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
b5c46bd1d9
feat(v2): new docs edit options: editCurrentVersion + editLocalizedDocs ( #3949 )
...
* editCurrentVersion initial poc
* ensure edit url allows to edit localized docs
* Add editLocalizedDocs option
* keep editing current version in dev (more convenient)
2020-12-28 10:25:47 +01:00
24ea18edf3
docs(v2): Added information about setting `/` in routeBasePath ( #3945 )
2020-12-22 16:25:33 +01:00
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
Joshua Chen