Skip to content

Conversation

@sxzz
Copy link
Member

@sxzz sxzz commented Apr 19, 2025

Thanks to @Gugustinette and @Triumph-light for their awesome work!

continue #112, closes #93

@sxzz sxzz marked this pull request as draft April 19, 2025 21:58
@netlify
Copy link

netlify bot commented Apr 19, 2025

Deploy Preview for tsdown ready!

Name Link
🔨 Latest commit 68f4ae5
🔍 Latest deploy log https://app.netlify.com/sites/tsdown/deploys/68045a39ab02650008384044
😎 Deploy Preview https://deploy-preview-119--tsdown.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Apr 19, 2025

Open in StackBlitz

npm i https://pkg.pr.new/tsdown@119

commit: 68f4ae5

@sxzz sxzz changed the title docs: documentation website (#112) docs: documentation website Apr 19, 2025
@Gugustinette
Copy link
Collaborator

Looks like my script broke on Netlify 💀

12:39:43 AM: $ pnpm run docs:generate && pnpm run docs:build
12:39:44 AM: > [email protected] docs:generate /opt/build/repo
12:39:44 AM: > ./docs/.vitepress/scripts/docs-generate.sh
12:39:44 AM: 📚 Generating reference...
12:39:46 AM: ✅ Reference generated successfully!
12:39:46 AM: 📚 Beautifying reference structure...
12:39:46 AM: sed: can't read 1,6d: No such file or directory
sed: can't read s/..\/type-aliases/.\/type-aliases/g: No such file or directory
sed: can't read 1,6d: No such file or directory

@Gugustinette
Copy link
Collaborator

It seems the sed command isn't the same on MacOS and Linux, maybe something like this could be done within the script :

function safe_sed() {
  if [[ "$OSTYPE" == "darwin"* ]]; then
    sed -i '' "$@"
  else
    sed -i "$@"
  fi
}

safe_sed '1,6d' ./docs/reference/config-options.md
safe_sed 's/..\/type-aliases/.\/type-aliases/g' ./docs/reference/config-options.md
safe_sed '1,6d' ./docs/reference/type-aliases/*.md

@sxzz
Copy link
Member Author

sxzz commented Apr 19, 2025

@Gugustinette I just invite you to this repo https://github.com/rolldown/tsdown/invitations
so that you can push the commits directly.

@Gugustinette
Copy link
Collaborator

Thanks, I'll try some fixes now !

@sxzz
Copy link
Member Author

sxzz commented Apr 19, 2025

We also need to copy docs/reference/config-options.md and docs/reference/type-aliases to zh-CN folder

@Gugustinette
Copy link
Collaborator

I can do that too, however they won't be translated, do we accept the reference in english everywhere ?

@sxzz
Copy link
Member Author

sxzz commented Apr 19, 2025

Translation in the API reference is unnecessary. Let's simply copy it as is.

@Gugustinette
Copy link
Collaborator

Should be fixed now ?

API Reference generation can really get a bit sketchy sometimes, I should create a dedicated plug and play library that fixes all these issues 🤔

@sxzz sxzz marked this pull request as ready for review April 20, 2025 02:36
@sxzz sxzz merged commit 48e0653 into main Apr 20, 2025
15 checks passed
@sxzz sxzz deleted the docs branch April 20, 2025 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation

4 participants