Skip to content

docs: migrate website to vitepress #2359

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

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open

Conversation

vmaerten
Copy link
Member

@vmaerten vmaerten commented Aug 7, 2025

Here we go!

This PR migrates the website from Docusaurus to VitePress. I've made a few changes along the way:

  • Switched from Yarn to pnpm, which is currently a better package manager.
  • Revamped several pages, including Schema and CLI.
  • Unified the folder structure (no more nested folders):

There might still be a few issues, i's a big change, so I may have missed something.

The preview won't be available until I change on netlify (but I'll broke current website).
You can test it locally.
Feel free to comment !

TODO :

  • Icon for admonition
  • Some icon are not rendered in dev mode

@vmaerten vmaerten force-pushed the migrate-to-vitepress branch from eeb021b to 70bc52f Compare August 7, 2025 09:55
@vmaerten vmaerten marked this pull request as ready for review August 7, 2025 09:56
@vmaerten vmaerten force-pushed the migrate-to-vitepress branch from 2dd11a9 to 7e531ad Compare August 7, 2025 10:05
@pd93 pd93 self-requested a review August 7, 2025 20:26
Copy link
Member

@pd93 pd93 left a comment

Choose a reason for hiding this comment

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

Fantastic start!

I still have a lot of reviewing to do, but this felt like enough for now. I'll keep looking over the next few days.

sponsor: 'https://github.com/sponsors/andreynering',
links: [
{ icon: 'github', link: 'https://github.com/andreynering' },
{ icon: 'x', link: 'https://x.com/andreynering' }
Copy link
Member

Choose a reason for hiding this comment

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

I assume @andreynering will want these updating too.

@@ -0,0 +1,5 @@
export const taskName = 'Task';
export const taskDescription =
'A fast, cross-platform build tool inspired by Make, designed for modern workflows.';
Copy link
Member

Choose a reason for hiding this comment

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

Is this officially our new tagline? If so, we should use this everywhere (GitHub/socials etc). Otherwise, this should stay the same as it is today.

Copy link
Member Author

Choose a reason for hiding this comment

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

I haven't told you, I tried something more engaging
But I am perfectly fine to stay with the current's one (that's why it's stored in the variable, easy to change)

What are your thoughts on it @andreynering and @pd93 ?

Copy link
Member

@andreynering andreynering left a comment

Choose a reason for hiding this comment

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

Looking good!

I didn't do a full pass yet but added a couple of comments in the meantime.

cmds:
- yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@latest @docusaurus/tsconfig@latest @docusaurus/types@latest
- pnpm netlify deploy --prod --site=054cd897-66d2-46fa-9b57-4831a8d61b37
Copy link
Member

Choose a reason for hiding this comment

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

@vmaerten Which site ID is this? I suppose it's a test one you created.

We're probably going to remove this because we'll have two sites now: taskfile.dev and next.taskfile.dev. We should set this via ENV.

Basically we'll need to:

  • Create a new website on Netlify to be next.taskfile.dev or change the domain of the current one to be next.taskfile.dev. IIRC it's Netlify that receives webhooks for pushes to main and builds the site.
  • Set up the website that will be the new taskfile.dev to deploy from GitHub Action on release as you did.

I can work on this if you want.

Copy link
Member Author

@vmaerten vmaerten Aug 8, 2025

Choose a reason for hiding this comment

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

Exactly, I planned to change it as soon we agree on the PR and netlify has been updated

We don't need to variabilise it because only taskfile.dev will be deployed with this Task
next.taskfile.dev will be deployed "from Github" like we have today (pushing on main)
So this siteId should be the taskfile.dev's one (deploy in the release with the netlify CLI)

I can work on this if you want.

As you wish, if you have time, I am fine with it :)

microservice directory and run a task command to bring it up without having to
create multiple tasks or Taskfiles with identical content. For example:
You can use this functionality along with the special
<span v-pre>`{{.USER_WORKING_DIR}}`</span> variable to create some very useful
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this was a search & replace that gone wrong.

Copy link
Member Author

Choose a reason for hiding this comment

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

Are you talking about <span v-pre> ?
If yes, it's because {{}} is interpreted as vue

image

vmaerten and others added 3 commits August 8, 2025 23:01
Co-authored-by: Andrey Nering <andreynering@users.noreply.github.com>
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.

3 participants