Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docusaurus): update to latest #3014

Merged
merged 53 commits into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from 51 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
9cfc0b6
chore(docusaurus): update to latest
thetaPC Jul 3, 2023
78c3bb0
chore(docusaurus): update paths
thetaPC Jul 3, 2023
806ced2
chore(docusaurus): docusaurus config update
thetaPC Jul 3, 2023
e90ea66
chore(docusaurus): theme components update
thetaPC Jul 3, 2023
da99aa3
chore(docusaurus): themeConfigScheme path update
thetaPC Jul 3, 2023
fb2e419
chore(docusaurus): removal of custsom docusaurus-theme-classic
thetaPC Jul 3, 2023
c969de4
chore(docusaurus): use ionic-ds
thetaPC Jul 3, 2023
5af40a9
chore(docusaurus): useScrollPositionBlocker path update
thetaPC Jul 3, 2023
3b4173d
chore(docusaurus): use colorMode instead of isDarkTheme (deprecated)
thetaPC Jul 3, 2023
1b4b665
chore(docusaurus): social links via css
thetaPC Jul 3, 2023
7f89e7b
chore(docusaurus): navbar cta
thetaPC Jul 3, 2023
163f9f1
chore(docusaurus): sidebar styles
thetaPC Jul 3, 2023
0b3cbdb
chore(docusaurus): social links nav styling
thetaPC Jul 3, 2023
b6381b0
chore(docusaurus): lint
thetaPC Jul 3, 2023
af1ec1f
chore(docusaurus): remove duplicate plugin
thetaPC Jul 3, 2023
487d8a2
chore(docusaurus): uninstall duplicate packages
thetaPC Jul 3, 2023
782a7ae
chore(docusaurus): remove transparent for search page
thetaPC Jul 3, 2023
ae81a73
chore(docusaurus): details on swizzle
thetaPC Jul 4, 2023
e4af97a
chore(docusaurus): update node
thetaPC Jul 20, 2023
8eaf36c
chore(docusaurus): correct type
thetaPC Jul 20, 2023
ad56f82
chore(docusaurus): navbar and sidebar styles
thetaPC Aug 1, 2023
e5d9ac8
chore(docusaurus): remove webkit css
thetaPC Aug 1, 2023
5209546
chore(docusaurus): cta and separator styles
thetaPC Aug 1, 2023
6ba7427
chore(docusaurus): sidebar ul margin top removal
thetaPC Aug 1, 2023
44eb7cc
Merge branch 'main' of github.com:ionic-team/ionic-docs into docusaur…
thetaPC Aug 1, 2023
642aaea
chore(docusaurus): update social link size
thetaPC Aug 4, 2023
26d28bc
chore(docusaurus): remove legacy-peer-deps
thetaPC Aug 8, 2023
eaefb54
chore(docusaurus): swizzled LocaleDropdownNavbarItem
thetaPC Aug 10, 2023
3a3e80c
chore(docusaurus): add original source for swizzled
thetaPC Aug 10, 2023
5e2ab7e
chore(docusaurus): remove console log
thetaPC Aug 10, 2023
07afdfa
chore(docusaurus)L: lint
thetaPC Aug 10, 2023
d1ec4be
docs(sidebar, top-nav): requested changes
thetaPC Sep 1, 2023
28d7b26
chore(docs): requested style changes
thetaPC Sep 1, 2023
91c7b18
chore(doc-item): margin in footer
thetaPC Sep 2, 2023
55bc40a
chore(navbar): remove order css
thetaPC Sep 2, 2023
2e051f5
chore(docusaurus): more requested changes
thetaPC Sep 21, 2023
4ac4192
chore(navbar): add missing close tag
thetaPC Sep 21, 2023
91db9ca
chore(docusaurus): add reasons for swizzle
thetaPC Sep 21, 2023
fb90efd
chore(docusaurus): wrapped instead of eject
thetaPC Sep 21, 2023
a3fe039
chore(localeDropdownNavbarItem): switch to tsx
thetaPC Sep 21, 2023
ac11a79
Merge branch 'main' of github.com:ionic-team/ionic-docs into docusaur…
thetaPC Sep 21, 2023
70dd033
chore(toc): fix edit page link
thetaPC Sep 21, 2023
5c0c6e0
chore(docusaurus): update docusaurus
thetaPC Sep 21, 2023
6473b5d
chore(docusaurus): hide docs demo on certain window size
thetaPC Sep 30, 2023
3b00897
chore(docusaurus): match search command to K size
thetaPC Sep 30, 2023
7f04586
chore(docusaurus): switch to margin-inline-start
thetaPC Sep 30, 2023
bc3f032
Merge branch 'main' of github.com:ionic-team/ionic-docs into docusaur…
thetaPC Oct 12, 2023
0bd636a
chore(docusaurus): update package-lock
thetaPC Oct 12, 2023
f05346a
chore(docusaurus): add missing packages
thetaPC Oct 12, 2023
f74a89b
chore(docusaurus): use the correct path
thetaPC Oct 12, 2023
449c02a
chore(docusaurus): add comments
thetaPC Oct 12, 2023
e059134
chore(docusaurus): smaller search icon
thetaPC Oct 27, 2023
72a0ccf
chore(docusaurus): update cmd symbol on search
thetaPC Oct 27, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,10 @@ Thanks for your interest in contributing to Ionic's documentation! :tada: Check
In order to run the documentation locally, install the dependencies and run the development server:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Command+K icon in the search field has the wrong ratio:

main branch
image image

The command symbol should roughly be the same size as the K


```sh
$ npm install --legacy-peer-deps
$ npm start
npm install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The translation icon in the top menu bar appears smaller/thinner than main

main branch
image image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to hide the default icon that Docusaurus renders and import a new icon via CSS. The new icon has a bolder setup. This feels a bit weird. Do we want to continue with this approach or use the default?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't fully understand: Is the thinner icon the default or the new icon you imported via CSS?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The thinner icon is the default that Docusaurus provides. Main also opts out of using the default and uses the import via CSS. The reason seems to be due to wanting a different icon at that time. Here's a screenshot of the imported icon and the default icon on main side by side.

Screenshot 2023-09-06 at 8 13 51 AM (main on left, Docusaurus on right)

Fast forward to today, Docusaurus has changed it's icon. It matches the one shown in main but the SVG is thinner.

Screenshot 2023-09-06 at 8 13 56 AM (main on left, Docusaurus on right)

I tried to match the default to main but couldn't get it so I opted to import main's icon via CSS. Realizing it now, I might be able to import the language icon from Ionicons. It might match the thickness. I'll give this a shot.

liamdebeasi marked this conversation as resolved.
Show resolved Hide resolved
npm start
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The margins seem larger now:

(top is branch, bottom is main. I added red guidelines for emphasis)

image

Also looks like the default arrow icon changed too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fixed. Let me know if it's still needs to be addressed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you do see some differences. It's due to Docusaurus changing how they calculate the columns.

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Note" fields are no longer yellow. Is this an intentional change?

Example:

branch: https://ionic-docs-git-docusaurus-update-ionic1.vercel.app/docs/cli#help
main: https://ionicframework.com/docs/cli#help


> [!NOTE]
> Certain versions of npm (5-8) and Node.js (10-16) are required to run certain scripts.

### Linting Documentation

This repository uses [Prettier](https://prettier.io/), an opinionated code formatter, in order to keep consistent formatting throughout the documentation. Run the following command to automatically fix all formatting, and then push any changes:
Expand Down
2 changes: 0 additions & 2 deletions docusaurus-theme-classic/.gitignore

This file was deleted.

Loading
Loading