Commit graph

58 commits

Author SHA1 Message Date
Mu-Jing-Tsai
39883e70de
docs: add docusaurus-post-generator to community resource list (#7955) 2022-08-16 18:59:47 +02:00
Sébastien Lorber
79360c6ae6
docs: publish 2.0.0 release blog post + adapt website for the launch (#7863) 2022-08-01 07:51:03 +02:00
Andrew Lyons
7489f8729a
docs: fix anchor link (#7813)
* docs: Correct link to document section

The link to the public API surface had an erroneous extra # in the link
preventing it from linking correctly.

* fix prettier

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-07-20 20:25:30 +08:00
Sébastien Lorber
f913af0d69
docs: release process, versioning, breaking changes, public API surface (#7706)
Co-authored-by: Paul O’Shannessy <paul@oshannessy.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-07-14 17:07:34 +02:00
Steven Serrata
9ce7d11309
docs: add docusaurus-openapi-docs to resources (#7675)
* Add docusaurus-openapi-docs to resources

* Add 'OpenAPI' to words list

* Edit description

* Add 'openapi' to project-words.txt
2022-06-25 00:57:18 +08:00
Webber Takken
35d320fa2c
docs: add awesome-docusaurus resource (#7563)
Add awesome-docusaurus resource
2022-06-24 12:12:44 +08:00
Joshua Chen
6a5efd068c
docs: mark some more fields as translatable (#7569) 2022-06-05 21:32:43 +08:00
Joshua Chen
2d94d575a1
refactor: make entire project typecheck with root tsconfig (#7466) 2022-05-23 12:54:25 +08:00
Joshua Chen
89b0fff128
refactor: reduce number of leaked anys (#7465) 2022-05-23 00:30:32 +08:00
Joshua Chen
0838884f67
chore: enable import/order rule (#7418) 2022-05-14 23:39:50 +08:00
Joshua Chen
6e10a48059
fix(content-docs): restore functionality when a category only has index page (#7385)
* fix(content-docs): restore functionality when a category only has index page

* use this internally
2022-05-10 14:50:43 +08:00
Joshua Chen
77fa3d1470
docs: display last canary publish date in human-readable format (#7367) 2022-05-07 20:17:58 +08:00
Sébastien Lorber
26df8c83ce
chore: prepare v2.0.0-beta.20 release (#7347) 2022-05-05 20:26:48 +02:00
Joshua Chen
9207cafec7
feat(website): make canary release page display actual canary version name (#7334) 2022-05-05 16:03:53 +02:00
Sergey Gromkov
dd4b7c84dd
docs: add Yandex Metrika plugin to community plugins (#7340)
* Adding Yandex Metrika plugin

* add words

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-05-05 18:16:22 +08:00
Chau Tran
1f77fc93bb
docs: add docusaurus-plugin-typedoc to resources (#7061) 2022-03-29 22:52:25 +08:00
Joshua Chen
f6ff6474bc
feat(website): new plugin to load CHANGELOG and render as blog (#6414)
* feat(website): new plugin to load CHANGELOG and render as blog

* use CJS

* move footer links

* better design

* fixes

* correctly order posts

* add authors

* Add axios

* Update styles

* oops

* oops

* add expand button

* back to index page link

* fix styles

* add feed options

* fix

* fix

* Add fallback

* fix

* fixes
2022-01-27 23:17:31 +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
35d3c02357
docs: update CONTRIBUTING for website (#6069)
* docs: update CONTRIBUTING for website

* Remove id

* Fix link
2021-12-08 20:24:44 +08:00
Andrew Taft
059c05248a
docs: Add plugin-image-zoom (#5746) 2021-10-20 12:39:10 +02:00
Jason Bosco
81877d7582
docs: add additional search options, typesense and local search (#5489)
* docs: add additional search bar options - typesense and local search

* docs: add typesense docsearch to community resources

* improve search doc, explain better where to get support

* improve search doc

* improve search doc

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-22 17:41:27 +02:00
Joshua Chen
cc75e85adb
docs: update all Discord links (#5581) 2021-09-17 21:25:31 +03:00
Daniel Costrasel
09a7e0b00b
docs: update docusaurus-plugin-relative-paths description (#5482) 2021-09-03 14:44:34 +02:00
Daniel Costrasel
e5d9ff18a8
docs: Add docusaurus-plugin-relative-paths (#5471) 2021-09-02 17:18:50 +02:00
Rohit Gohri
c7f337e3b5
docs: add Redocusaurus in community plugin list (#5436)
Ref: 
- https://github.com/facebook/docusaurus/issues/638#issuecomment-762502498
- https://github.com/rohit-gohri/redocusaurus
2021-08-28 21:25:37 +03:00
Sébastien Lorber
f40ce05102
refactor: clean Canny integration + rename 'Feedback' to 'Feature Requests' + improve TS doc page (#5389)
* Better Canny integration

* Add missing netlify redirects

* polish

* TS doc: mention it's possible to use JSDoc in config

* issue templates: use /feature-requests new url
2021-08-20 11:42:13 +02:00
Paul O’Shannessy
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
Sam Wall
10ac9a6f2a
docs: add mdx-mermaid to resources (#5332) 2021-08-11 09:44:09 +03:00
Sébastien Lorber
49715d7a36
docs: Changelog page should display TOC with releases (#5331) 2021-08-10 19:56:41 +02:00
Sébastien Lorber
6b396055f8
fix: fix changelog page mdx import for i18n (#5312) 2021-08-06 19:09:29 +02:00
Sébastien Lorber
916b82119b
feat: mdx loader fallback, allow importing mdx docs from anywhere (#5299)
* move deep filepath test

* split markdownPageExample.md

* re-org dogfooding content

* Add mdx partials fallback synthetic plugin by default

* test commit

* hide changelog title as it's already included in the partial file

* trigger CI

* fix changelog sidebar label
2021-08-06 11:32:22 +02:00
Sébastien Lorber
81e6578fae
docs: update canary doc (#5296) 2021-08-05 14:38:48 +02:00
Sébastien Lorber
33b88ab717
fix: fix canary release versions (#5285) 2021-08-04 18:34:06 +02:00
Forresst
d7e483557e
docs: Fix typo 2-resources.md (#5253)
Fix typo
2021-07-30 11:06:45 +02:00
Tunghsiao Liu
4beb218abe
docs(v2): add docusaurus-prince-pdf to resources (#5248) 2021-07-29 18:56:39 +02:00
Sébastien Lorber
59f78f9084
docs(v2): document canary releases (#4987) 2021-06-16 16:11:41 +02:00
antonygibbs
36b91a9b72
docs(v2): add mr-pdf to resources (#4818)
* Update 2-resources.md

Added new option for PDF generation seeing as docusaurus-pdf doesn't work beyond 2.0.0.-alpha73, as establised in [bug #29](https://github.com/kohheepeace/docusaurus-pdf/issues/29).

* Update 2-resources.md

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-05-25 12:28:33 +03: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
Dennis Thompson
04fa8c2755
Open docs(v2): Adding new community plugins (#4622) 2021-04-16 10:09:55 +02:00
Sébastien Lorber
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

* POC of auto-generated sidebars for community docs

* update tests

* add initial test suite for autogenerated sidebars + fix some edge cases

* Improve autogen sidebars: strip more number prefixes in folder breadcrumb + slugs

* fix typo!

* Add tests for partially generated sidebars + fix edge cases + extract sidebar generation code

* Ability to read category metadatas file from a file in the category

* fix tests

* change position of API

* ability to extract number prefix

* stable system to enable position frontmatter

* fix tests for autogen sidebar position

* renamings

* restore community sidebars

* rename frontmatter position -> sidebar_position

* make sidebarItemsGenerator fn configurable

* minor changes

* rename dirPath => dirName

* Make the init template use autogenerated sidebars

* fix options

* fix docusaurus site: remove test docs

* add _category_ file to docs pathsToWatch

* add _category_ file to docs pathsToWatch

* tutorial: use sidebar_position instead of file number prefixes

* Adapt Docusaurus tutorial for autogenerated sidebars

* remove slug: /

* polish the homepage template

* rename _category_ sidebar_position to just "position"

* test for custom sidebarItemsGenerator fn

* fix category metadata + add link to report tutorial issues

* fix absolute path breaking tests

* fix absolute path breaking tests

* Add test for floating number sidebar_position

* add sidebarItemsGenerator unit tests

* add processSidebars unit tests

* Fix init template broken links

* windows test

* increase code translations test timeout

* cleanup mockCategoryMetadataFiles after windows test fixed

* update init template positions

* fix windows tests

* fix comment

* Add autogenerated sidebar items documentation + rewrite the full sidebars page doc

* add useful comment

* fix code block title
2021-04-15 16:20:11 +02:00
Anthony Bobsin
4c09249d72
docs(v2): Include docusaurus-protobuffet to community plugins (#4594) 2021-04-11 17:43:18 +02:00
Arijit Kundu
af840b7f85
docs(v2, v1): fixed typos (#4479) 2021-03-22 18:00:32 +01:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Sébastien Lorber
1734975f2f
feat(v2): Add Interpolate / interpolate APIs + complete theme translations (#4295)
* WIP: refactor team profile cards

* Add Interpolate / interpolate APIs

* Add interpolate snapshot test

* comments

* fix Interpolate TS types

* Interpolate should handle numbers and other JS types

* translate BlogPostItem

* interpolate translate() fn + add translations for blog post tag header

* localize the LastUpdated component

* translate DocVersionSuggestions

* fix test

* add some new translations

* Add node script to easily update the theme default translations

* fix translation extractor bug due to translate() dynamic values

* use ICU placeholder syntax

* refactor month key

* order

* team  page translation improvements

* Add interpolation doc + improve i18n doc
2021-02-26 13:19:51 +01:00
Grégory Heitz
ffb9ad0356
docs(v2): Add docusaurus2-graphql-doc-generator to community resources (#4256) 2021-02-22 15:44:12 +01:00
Reece Dunham
6af8fbb0d2
docs(v2): Add docusaurus-plugin-remote-content to resources list (#4177)
Signed-off-by: Reece Dunham <me@rdil.rocks>
2021-02-04 18:59:21 +01:00
Christian Bromann
9fc30b3d5a
docs(v2): Add docusaurus-theme-github-codeblock (#4161) 2021-02-03 12:25:45 +01:00
Nahiyan Kamal
6f4aad7f78
docs(v2): community docs typo fix (#4144) 2021-02-01 12:03:37 +01:00
Eric Carboni
d5de891a8d
docs(v2): update broken link on resources page (#4106) 2021-01-27 15:14:48 +01:00
Derric Gilling
d61754b3d5
docs(v2): Add docusaurus-plugin-moesif to community plugins (#3867) 2020-12-03 10:49:39 +01:00