From 5f423e4c2ea105897363a560122f7a5227766690 Mon Sep 17 00:00:00 2001 From: Neko Ayaka Date: Mon, 16 Jun 2025 01:48:51 +0800 Subject: [PATCH] refactor: cleanup root dir --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 .npmrc | 1 - changelogithub.config.ts | 3 - cspell.config.yaml | 1 - README.ja-JP.md => docs/README.ja-JP.md | 0 docs/README.md | 55 +------------ README.zh-CN.md => docs/README.zh-CN.md | 0 package.json | 2 - pnpm-lock.yaml | 95 ++++------------------ 9 files changed, 17 insertions(+), 140 deletions(-) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) delete mode 100644 .npmrc delete mode 100644 changelogithub.config.ts rename README.ja-JP.md => docs/README.ja-JP.md (100%) rename README.zh-CN.md => docs/README.zh-CN.md (100%) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.npmrc b/.npmrc deleted file mode 100644 index bf2e7648b..000000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -shamefully-hoist=true diff --git a/changelogithub.config.ts b/changelogithub.config.ts deleted file mode 100644 index 85c7b2d77..000000000 --- a/changelogithub.config.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { defineConfig } from 'changelogithub' - -export default defineConfig({ draft: true }) diff --git a/cspell.config.yaml b/cspell.config.yaml index 31068dafa..70568c6ad 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -26,7 +26,6 @@ words: - browserbasehq - bumpp - catppuccin - - changelogithub - cientos - cjkfonts - clippy diff --git a/README.ja-JP.md b/docs/README.ja-JP.md similarity index 100% rename from README.ja-JP.md rename to docs/README.ja-JP.md diff --git a/docs/README.md b/docs/README.md index f9f6d31c6..4b44f80ac 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,54 +1 @@ -# Starlight Starter Kit: Basics - -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) - -``` -npm create astro@latest -- --template starlight -``` - -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics) -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs) - -> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun! - -## πŸš€ Project Structure - -Inside of your Astro + Starlight project, you'll see the following folders and files: - -``` -. -β”œβ”€β”€ public/ -β”œβ”€β”€ src/ -β”‚ β”œβ”€β”€ assets/ -β”‚ β”œβ”€β”€ content/ -β”‚ β”‚ β”œβ”€β”€ docs/ -β”‚ └── content.config.ts -β”œβ”€β”€ astro.config.mjs -β”œβ”€β”€ package.json -└── tsconfig.json -``` - -Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name. - -Images can be added to `src/assets/` and embedded in Markdown with a relative link. - -Static assets, like favicons, can be placed in the `public/` directory. - -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | - -## πŸ‘€ Want to learn more? - -Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). +Please refer to [../README.md](../README.md) for the main documentation. diff --git a/README.zh-CN.md b/docs/README.zh-CN.md similarity index 100% rename from README.zh-CN.md rename to docs/README.zh-CN.md diff --git a/package.json b/package.json index c991987a7..79da29533 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,6 @@ "lint:rust": "cargo fmt --check && cargo clippy --workspace", "typecheck": "pnpm -rF=\"./packages/*\" -F=\"./apps/*\" -F run --parallel typecheck", "up": "taze -w -r -I -f && pnpm prune && pnpm dedupe", - "changelogithub": "changelogithub", "sizecheck": "npx vite-bundle-visualizer", "nolyfill": "pnpm dlx nolyfill" }, @@ -48,7 +47,6 @@ "@unocss/eslint-plugin": "^66.2.0", "@vitest/coverage-v8": "^3.2.3", "bumpp": "^10.1.1", - "changelogithub": "^13.15.0", "eslint": "^9.28.0", "eslint-plugin-import-x": "^4.15.2", "execa": "^9.6.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 1866627f3..4fc1727ff 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -90,9 +90,6 @@ importers: bumpp: specifier: ^10.1.1 version: 10.1.1(magicast@0.3.5) - changelogithub: - specifier: ^13.15.0 - version: 13.15.0(magicast@0.3.5) eslint: specifier: ^9.28.0 version: 9.28.0(jiti@2.4.2) @@ -5968,14 +5965,6 @@ packages: resolution: {integrity: sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==} engines: {node: '>= 0.8'} - c12@1.11.2: - resolution: {integrity: sha512-oBs8a4uvSDO9dm8b7OCFW7+dgtVrwmwnrVXYzLm43ta7ep2jCn/0MhoUFygIWtxhyy6+/MG7/agvpY0U1Iemew==} - peerDependencies: - magicast: ^0.3.4 - peerDependenciesMeta: - magicast: - optional: true - c12@2.0.1: resolution: {integrity: sha512-Z4JgsKXHG37C6PYUtIxCfLJZvo6FyhHJoClwwb9ftUkLpPSkuYqn6Tr+vnaN8hymm0kIbcg6Ey3kv/Q71k5w/A==} peerDependencies: @@ -6050,15 +6039,6 @@ packages: change-case@5.4.4: resolution: {integrity: sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==} - changelogen@0.5.7: - resolution: {integrity: sha512-cTZXBcJMl3pudE40WENOakXkcVtrbBpbkmSkM20NdRiUqa4+VYRdXdEsgQ0BNQ6JBE2YymTNWtPKVF7UCTN5+g==} - hasBin: true - - changelogithub@13.15.0: - resolution: {integrity: sha512-qPQ896hrTKXYHzFTH1c1O4KRfk4IwxOp22fKBUBGYqcB13z8B6bNoViSX50Z6SbmcQjHLHwyOMfACJVn74x5LA==} - engines: {node: '>=12.0.0'} - hasBin: true - character-entities-html4@2.1.0: resolution: {integrity: sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==} @@ -6268,9 +6248,6 @@ packages: resolution: {integrity: sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==} engines: {node: '>= 0.6'} - convert-gitmoji@0.1.5: - resolution: {integrity: sha512-4wqOafJdk2tqZC++cjcbGcaJ13BZ3kwldf06PTiAQRAB76Z1KJwZNL1SaRZMi2w1FM9RYTgZ6QErS8NUl/GBmQ==} - convert-source-map@2.0.0: resolution: {integrity: sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==} @@ -17472,23 +17449,6 @@ snapshots: bytes@3.1.2: {} - c12@1.11.2(magicast@0.3.5): - dependencies: - chokidar: 3.6.0 - confbox: 0.1.8 - defu: 6.1.4 - dotenv: 16.5.0 - giget: 1.2.3 - jiti: 1.21.7 - mlly: 1.7.4 - ohash: 1.1.4 - pathe: 1.1.2 - perfect-debounce: 1.0.0 - pkg-types: 1.3.1 - rc9: 2.1.2 - optionalDependencies: - magicast: 0.3.5 - c12@2.0.1(magicast@0.3.5): dependencies: chokidar: 4.0.3 @@ -17580,38 +17540,6 @@ snapshots: change-case@5.4.4: {} - changelogen@0.5.7(magicast@0.3.5): - dependencies: - c12: 1.11.2(magicast@0.3.5) - colorette: 2.0.20 - consola: 3.4.2 - convert-gitmoji: 0.1.5 - mri: 1.2.0 - node-fetch-native: 1.6.6 - ofetch: 1.4.1 - open: 10.1.2 - pathe: 1.1.2 - pkg-types: 1.3.1 - scule: 1.3.0 - semver: 7.7.2 - std-env: 3.9.0 - yaml: 2.8.0 - transitivePeerDependencies: - - magicast - - changelogithub@13.15.0(magicast@0.3.5): - dependencies: - ansis: 4.1.0 - c12: 3.0.4(magicast@0.3.5) - cac: 6.7.14 - changelogen: 0.5.7(magicast@0.3.5) - convert-gitmoji: 0.1.5 - execa: 9.6.0 - ofetch: 1.4.1 - semver: 7.7.2 - transitivePeerDependencies: - - magicast - character-entities-html4@2.1.0: {} character-entities-legacy@3.0.0: {} @@ -17638,7 +17566,8 @@ snapshots: dependencies: readdirp: 4.0.2 - chownr@2.0.0: {} + chownr@2.0.0: + optional: true chownr@3.0.0: {} @@ -17811,8 +17740,6 @@ snapshots: content-type@1.0.5: {} - convert-gitmoji@0.1.5: {} - convert-source-map@2.0.0: {} cookie-es@1.2.2: {} @@ -19191,6 +19118,7 @@ snapshots: fs-minipass@2.1.0: dependencies: minipass: 3.3.6 + optional: true fs.realpath@1.0.0: {} @@ -19297,6 +19225,7 @@ snapshots: ohash: 1.1.4 pathe: 1.1.2 tar: 6.2.1 + optional: true giget@2.0.0: dependencies: @@ -21181,8 +21110,10 @@ snapshots: minipass@3.3.6: dependencies: yallist: 4.0.0 + optional: true - minipass@5.0.0: {} + minipass@5.0.0: + optional: true minipass@7.1.2: {} @@ -21190,6 +21121,7 @@ snapshots: dependencies: minipass: 3.3.6 yallist: 4.0.0 + optional: true minizlib@3.0.1: dependencies: @@ -21198,7 +21130,8 @@ snapshots: mitt@3.0.1: {} - mkdirp@1.0.4: {} + mkdirp@1.0.4: + optional: true mkdirp@3.0.1: {} @@ -21431,6 +21364,7 @@ snapshots: pathe: 1.1.2 pkg-types: 1.3.1 ufo: 1.6.1 + optional: true nypm@0.6.0: dependencies: @@ -21454,7 +21388,8 @@ snapshots: node-fetch-native: 1.6.6 ufo: 1.6.1 - ohash@1.1.4: {} + ohash@1.1.4: + optional: true ohash@2.0.11: {} @@ -23439,6 +23374,7 @@ snapshots: minizlib: 2.1.2 mkdirp: 1.0.4 yallist: 4.0.0 + optional: true tar@7.4.3: dependencies: @@ -24950,7 +24886,8 @@ snapshots: yallist@3.1.1: {} - yallist@4.0.0: {} + yallist@4.0.0: + optional: true yallist@5.0.0: {}