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.

Sign up for GitHub

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

docs(mkdocs): add config to use emoji #3613

Closed
wants to merge 1 commit into from
Closed

docs(mkdocs): add config to use emoji #3613

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions mkdocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,6 @@ markdown_extensions:
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: "#"

Copy link
Contributor

Choose a reason for hiding this comment

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

[style]

  • No unnecessary new line.
  • Sort alphabetically.
Suggested change

Copy link
Contributor

Choose a reason for hiding this comment

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

FYI: Maybe adding sync settings like this is useful.
https://github.com/autowarefoundation/open-ad-kit-docs/blob/0c1c70625fb89d144a5e2d5df52d0cdccd6e18c4/.github/sync-files.yaml#L37-L41
https://github.com/autowarefoundation/autoware-documentation/blob/fa986159d4fd83d81f232f5ec1e657e5685f495f/mkdocs.yaml#L67-L69

Copy link
Contributor Author

@satoshi-ota satoshi-ota May 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I added sync in #3620, and #3619 is generated.

Would my these changes be as you intended?

If you so, I'll close this PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, exactly. Thank you!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for your comments!

- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_alt