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

wechaty document referencing problem #1480

Open
iyjian opened this issue Feb 12, 2022 · 1 comment
Open

wechaty document referencing problem #1480

iyjian opened this issue Feb 12, 2022 · 1 comment

Comments

@iyjian
Copy link
Contributor

iyjian commented Feb 12, 2022

some references in wechaty.js.org doc are not working, for example when you click RoomEventName under room event listener doc , it can not reference to the correct position.

after some investigations, I found the problem:

by default, docusaurus uses auto generated markdown head ids for referencing. for example if markdown head is ## Hello World, we can use [Hello World](wechaty.md#hello-world) for referencing in docusaurus docs. but in the above example, we use [RoomEventName](room.md#RoomEventName) (not convert to lowwercase).

I was wondering if we can use write-id-cli to generate static head id, then change the reference link to the generated static head in our docs.

after search, I found we have 56 modifications.

image

10 + 3 + 8 + 35 = 56

@iyjian iyjian self-assigned this Feb 12, 2022
@iyjian iyjian removed their assignment Feb 13, 2022
@Mackenzie-OO7
Copy link

@iyjian Hello, I would like to work on this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants