Commit graph

1129 commits

Author SHA1 Message Date
Steven Hansel
cd47d8a815
feat(v2): add unique page/wrapper className to each theme pages (#4511)
* chore: add theme classnames for blog pages

* fix: component syntax error in blog pages

* style: fix camelcase issue with theme class names

* chore: add theme classnames for doc page and mdx page

* chore: make wrapper classnames in blog and doc page into constants

* chore: add main wrapper theme class name for layout component

* fix: change wrong theme classnames and improve naming

* chore: add wrapper theme class name for mdx page

* docs: add docs for theme class names

* docs: use raw-loader to import documentation and add some comments

* docs: provide more detail to comment

* chore: rename ThemeClassname.ts to ThemeClassName.ts

Co-authored-by: Lisa Chandra <52909743+lisa761@users.noreply.github.com>
Co-authored-by: Javid <singularity.javid@gmail.com>
2021-04-15 18:36:40 +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
guoxudong
fbe4a4ac14
docs(v2): add Kubevela showcase (#4616)
Co-authored-by: guoxudong <guoxudong.dev@gmial.com>
2021-04-15 16:03:04 +02:00
akepecs
5ded1eb95d
docs(v2): Added IntelAGENT website to showcase. (#4612)
* Added IntelAGENT website to showcase.

* Added IntelAGENT png
2021-04-14 09:26:49 +02:00
Dick Wyn Yong
de9f414919
docs(v2): add clarity to tip in versioned using-themes page (#4609) 2021-04-13 19:59:50 +02:00
Artur Carvalho
cbb31783d7
docs(v2): heading typo (#4606) 2021-04-13 11:24:46 +02:00
Dick Wyn Yong
edfc7ff3b8
docs(v2): add clarity to tip in using-themes page (#4604) 2021-04-13 11:23:18 +02:00
Brent Ely
7ba0fdf831
docs(v2): Add "PptxGenJS" to showcase (#4602)
* Added PptxGenJS

* added new image for pptxgenjs

* Update website/src/data/users.js

* Update website/src/data/users.js

* Update users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-04-13 11:11:53 +02:00
Alexey Pyltsyn
6b0df65786
fix(v2): render escaped HTML entities inside code properly (#4598) 2021-04-12 18:33:38 +02:00
Sébastien Lorber
41af0c9f90
docs(v2): i18n site: enable ko + zh-CN locales (#4599)
* enable locales

* do not deploy multiple locales in netlify deploy preview: keep it fast
2021-04-11 19:21:13 +02:00
Forresst
aa392a9907
docs(v2): fix typo theme-configuration.md (#4595)
We are in the footer section, I think it's a bad copy and paste
2021-04-11 17:44:35 +02:00
Anthony Bobsin
4c09249d72
docs(v2): Include docusaurus-protobuffet to community plugins (#4594) 2021-04-11 17:43:18 +02:00
Sébastien Lorber
cb403afa93
fix(v2): i18n perf issue: getTranslationFile() should not load content again (#4593)
* Fix getTranslationFiles() perf issue

* improve doc
2021-04-09 19:28:48 +02:00
Tales Porto
e99bb43823
feat(v2): docusaurus deploy: ability to configure port in git url (#4545)
* Creating a way to configure the port used on the guthub deploy.

* Fixing some mistakes

Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.

* Fixing some mistakes

Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.

* Isolating the logic to generate the url and testing it.

* Changing all the names used on tests to something more unserstandable.

* Prettify

Co-authored-by: Tales Porto <t.andrade-porto@klarna.com>
2021-04-09 18:05:16 +02:00
Arijit Kundu
4a219f1983
docs(v2); fixed broken link i18n-tutorial.md (#4558) 2021-04-05 19:00:54 +02:00
Arijit Kundu
d324dc3869
docs(v2): fixed the directory of index.js (#4559) 2021-04-05 18:56:14 +02:00
Arijit Kundu
ecc3444865
docs(v2): fixed typos (#4560)
* docs(v2): fixed typos

* docs(v2): fixed typos
2021-04-05 18:42:41 +02:00
Tony Narlock
a627a264fb
docs(v2): add social-embed to showcase (#4568) 2021-04-05 18:35:04 +02:00
Ajeet Singh Raina, Docker Captain, RedisLabs
d9067748fd
docs(v2): Add Redis Labs Developer Site to docusaurus showcase page (#4570)
* Add files via upload

* Update users.js
2021-04-05 18:33:21 +02:00
Lucas Alves
5357fcefee
docs(v2): Updates showcase: Channel.js renamed to Repeater.js (#4551)
* fix: Updates Channel.js to Repeater.js

* fix: Includes Repeater.js in alphabetical order
2021-04-02 12:21:17 +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
Forresst
51a7988923
docs(v2): fix typo deployment.mdx (#4539) 2021-03-31 15:51:13 +02:00
Pedro Piñera Buendía
e6a8111025
docs(v2): Add Tuist to the list of projects that use Docusaurus (#4538) 2021-03-30 19:41:34 +02:00
Armano
5534affdb9
fix(v2): remove no longer used postcss-present-env from dependencies (#4506) 2021-03-29 18:04:13 +02:00
ZhengYuan Loo
11843a02fe
docs(v2): config for self-hosted docsearch crawler (#4524) 2021-03-29 17:53:51 +02:00
Forresst
b9de28e42f
docs(v2): fix markdown headings level 4 (#4526) 2021-03-29 17:23:20 +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
Sébastien Lorber
819bb43433
docs(v2): add more links to v1: announcementBar, versionDropdown, homepage (#4505)
* add more links to v1 doc + use Translate interpolation

* add more links to v1 doc + use Translate interpolation

* add version dropdown link to v1 domain
2021-03-23 19:08:36 +01:00
Armano
1f8e0bc48e
docs(v2): add missing version link to legacy (v1) version of website (#4504) 2021-03-23 18:50:29 +01: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
Forresst
fb372c574d
docs: fix link to issue template (#4497) 2021-03-23 17:00:58 +01:00
Sébastien Lorber
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
Sébastien Lorber
aaea26602b
chore: prepare v1-v2 domain switch (#4475)
* prepare v1-v2 domain switch

* rename v1 changelog as CHANGELOG-1.x.md

* switch v1/v2 changelogs
2021-03-22 20:26:47 +01:00
Arijit Kundu
af840b7f85
docs(v2, v1): fixed typos (#4479) 2021-03-22 18:00:32 +01:00
aehrea
3c165c3b89
docs(v2): fix grammar and improve wording (#4481)
- resolve grammar issue in Setup heading and rephrase to (subjectively) more clear wording
- more consistent wording in first line of Versioned paths heading
2021-03-22 17:57:11 +01:00
Arijit Kundu
be6ef076f0
docs(v2): corrected the use of delimiters (#4478) 2021-03-21 12:23:08 +03:00
Arijit Kundu
9bdb9eb630
docs(v2): fixed broken link in sidebar documentation (#4472) 2021-03-19 22:29:03 +03:00
Sébastien Lorber
dd5e5098b8
docs(v2): Add missing i18n docs: API lifecycles + Crowdin migration guide (#4470)
* Add the missing i18n docs: Crowdin migration + i18n lifecycle APIs

* fix heading ids

* fix doc typo
2021-03-19 18:19:30 +01:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Sébastien Lorber
5543f09ed1
chore: json files should be linted (#4462) 2021-03-18 19:39:50 +01:00
Sébastien Lorber
892d832a3e
fix(v2): Fix i18n staging deployment due to json typo (#4461) 2021-03-18 19:28:14 +01:00
Sébastien Lorber
60d189a91c
fix(v2): Export Joi from validation-utils package (#4459) 2021-03-18 19:27:51 +01:00
Sébastien Lorber
03f4a92035
chore(v2): enable more staging locales (#4458) 2021-03-18 18:05:42 +01:00
Sébastien Lorber
3422f80a9a
chore: simplify CI setup (#4447)
* improve ci

* improve ci

* use actions/setup-node@v2 everywhere

* run pwd for test

* debug gh action

* debug glob CI issue?

* Separate v1/v2 tests due to shell conflict

* cleanup

* test v1 change

* circleci fix

* fix test docusaurus v1 paths

* Refactor CI script names and use paths to filter  actions from running unnecessary

* fix lighthouse url

* v1 tests runInBand

* try to fix v1 tests race conditions

* change rootDir for v1 tests

* minor CI improvements
2021-03-18 17:40:28 +01:00
Alexey Pyltsyn
1135d19333
chore(v2): remove docs for alpha v70 (#4457) 2021-03-18 18:36:58 +03:00
Sébastien Lorber
806fdbaf27
feat(v2): infer default i18n locale config from locale code (#4449)
* improve locale default config

* remove localeConfigs from i18n tutorial

* better i18n types, tests and Intl.DisplayNames integration
2021-03-18 11:43:07 +01:00
John Reilly
f041a37622
docs(v2): add johnnyreilly blog to showcase (#4446) 2021-03-17 16:48:17 +01:00
Reece Dunham
76c0b11632
refactor(v2): TS config update: reduce the size of npm modules (#4375)
* feat(v2): Reduce the size of the npm modules

Signed-off-by: Reece Dunham <me@rdil.rocks>

* Fix conflicts

* Update search.js

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-17 16:25:42 +01:00
Steve
66e621dca9
docs(v2): add Deploy with QuandCDN (#4430)
* Update deployment.mdx

- Adds QuantCDN deployment target.

* Update deployment.mdx

* Update website/docs/deployment.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* Add QuantCDN docs to showcase.

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-03-16 19:25:12 +01:00
Tom Raviv
07733e1b9c
docs(v2): add stylable site to users showcase list (#4441)
* added stylable site to users list

* Update website/src/data/users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-03-16 19:11:01 +01:00