-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
19 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,31 @@ | ||
| # Turborepo starter | ||
| # hexo-plugin | ||
|
|
||
| This is an official starter Turborepo. | ||
| [](https://github.com/uiolee/hexo-plugin/actions/workflows/ci.yml) | ||
| [](https://github.com/uiolee/hexo-plugin/actions/workflows/release.yml) | ||
| [](https://coveralls.io/github/uiolee/hexo-plugin?branch=main) | ||
| [](https://codecov.io/gh/uiolee/hexo-plugin) | ||
|
|
||
| ## Using this example | ||
| Turborepo of uiolee's hexo-plugin | ||
|
|
||
| Run the following command: | ||
| ## plugins list | ||
|
|
||
| ```sh | ||
| npx create-turbo@latest | ||
| ``` | ||
|
|
||
| ## What's inside? | ||
|
|
||
| This Turborepo includes the following packages/apps: | ||
|
|
||
| ### Apps and Packages | ||
|
|
||
| - `docs`: a [Next.js](https://nextjs.org/) app | ||
| - `web`: another [Next.js](https://nextjs.org/) app | ||
| - `@repo/ui`: a stub React component library shared by both `web` and `docs` applications | ||
| - `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) | ||
| - `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo | ||
|
|
||
| Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). | ||
|
|
||
| ### Utilities | ||
| <!-- packages-list start --> | ||
|
|
||
| This Turborepo has some additional tools already setup for you: | ||
| | name | path | version | deps | npmjs | download | | ||
| | ------------------------- | ---------------------------------------------------------------------------- | ------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | hexo-absolute | [./plugins/hexo-absolute/](./plugins/hexo-absolute/) | 1.0.2 | 1 | [](https://www.npmjs.com/package/hexo-absolute) | [](https://www.npmjs.com/package/hexo-absolute) | | ||
| | hexo-esbuild | [./plugins/hexo-esbuild/](./plugins/hexo-esbuild/) | 0.1.0 | 2 | [](https://www.npmjs.com/package/hexo-esbuild) | [](https://www.npmjs.com/package/hexo-esbuild) | | ||
| | @uiolee/hexo-htmlnano | [./plugins/hexo-htmlnano/](./plugins/hexo-htmlnano/) | 0.1.2 | 2 | [](https://www.npmjs.com/package/@uiolee/hexo-htmlnano) | [](https://www.npmjs.com/package/@uiolee/hexo-htmlnano) | | ||
| | hexo-symbols-count-time-2 | [./plugins/hexo-symbols-count-time-2/](./plugins/hexo-symbols-count-time-2/) | 2.0.1 | 0 | [](https://www.npmjs.com/package/hexo-symbols-count-time-2) | [](https://www.npmjs.com/package/hexo-symbols-count-time-2) | | ||
| | hexo-workbox-build | [./plugins/hexo-workbox-build/](./plugins/hexo-workbox-build/) | 2.0.1 | 2 | [](https://www.npmjs.com/package/hexo-workbox-build) | [](https://www.npmjs.com/package/hexo-workbox-build) | | ||
|
|
||
| - [TypeScript](https://www.typescriptlang.org/) for static type checking | ||
| - [ESLint](https://eslint.org/) for code linting | ||
| - [Prettier](https://prettier.io) for code formatting | ||
| <!-- packages-list end --> | ||
|
|
||
| ### Build | ||
|
|
||
| To build all apps and packages, run the following command: | ||
|
|
||
| ``` | ||
| cd my-turborepo | ||
| ```bash | ||
| cd hexo-plugin | ||
| pnpm build | ||
| ``` | ||
|
|
||
| ### Develop | ||
|
|
||
| To develop all apps and packages, run the following command: | ||
|
|
||
| ``` | ||
| cd my-turborepo | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| ### Remote Caching | ||
|
|
||
| Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. | ||
|
|
||
| By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/#), then enter the following commands: | ||
|
|
||
| ``` | ||
| cd my-turborepo | ||
| npx turbo login | ||
| ``` | ||
|
|
||
| This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). | ||
|
|
||
| Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: | ||
|
|
||
| ``` | ||
| npx turbo link | ||
| ``` | ||
|
|
||
| ## Useful Links | ||
|
|
||
| Learn more about the power of Turborepo: | ||
|
|
||
| - [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) | ||
| - [Caching](https://turbo.build/repo/docs/core-concepts/caching) | ||
| - [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) | ||
| - [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) | ||
| - [Configuration Options](https://turbo.build/repo/docs/reference/configuration) | ||
| - [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters