diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..6240da8 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,21 @@ +# build output +dist/ +# generated types +.astro/ + +# dependencies +node_modules/ + +# logs +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* + + +# environment variables +.env +.env.production + +# macOS-specific files +.DS_Store diff --git a/docs/.prettierrc b/docs/.prettierrc new file mode 100644 index 0000000..20791be --- /dev/null +++ b/docs/.prettierrc @@ -0,0 +1,14 @@ +{ + "useTabs": true, + "printWidth": 100, + "semi": false, + "plugins": ["prettier-plugin-astro", "prettier-plugin-tailwindcss"], + "overrides": [ + { + "files": "*.astro", + "options": { + "parser": "astro" + } + } + ] +} diff --git a/docs/.vscode/extensions.json b/docs/.vscode/extensions.json new file mode 100644 index 0000000..22a1505 --- /dev/null +++ b/docs/.vscode/extensions.json @@ -0,0 +1,4 @@ +{ + "recommendations": ["astro-build.astro-vscode"], + "unwantedRecommendations": [] +} diff --git a/docs/.vscode/launch.json b/docs/.vscode/launch.json new file mode 100644 index 0000000..d642209 --- /dev/null +++ b/docs/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "command": "./node_modules/.bin/astro dev", + "name": "Development server", + "request": "launch", + "type": "node-terminal" + } + ] +} diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..610da00 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,56 @@ +# Starlight Starter Kit: Tailwind + +[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) + +``` +npm create astro@latest -- --template starlight/tailwind +``` + +[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/tailwind) +[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/tailwind) +[![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/tailwind) +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Ftailwind&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/ +β”‚ β”‚ └── config.ts +β”‚ └── env.d.ts +β”œβ”€β”€ astro.config.mjs +β”œβ”€β”€ package.json +β”œβ”€β”€ tailwind.config.mjs +└── 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). diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs new file mode 100644 index 0000000..5ecc59f --- /dev/null +++ b/docs/astro.config.mjs @@ -0,0 +1,33 @@ +import { defineConfig } from "astro/config" +import starlight from "@astrojs/starlight" +import tailwind from "@astrojs/tailwind" + +// https://astro.build/config +export default defineConfig({ + redirects: { + "/": "/guides/getting-started", + }, + integrations: [ + starlight({ + title: "pesde docs", + social: { + github: "https://github.com/daimond113/pesde", + }, + sidebar: [ + { + label: "Guides", + items: [{ label: "Getting Started", slug: "guides/getting-started" }], + }, + { + label: "Reference", + autogenerate: { directory: "reference" }, + }, + ], + components: { + SiteTitle: "./src/components/SiteTitle.astro", + }, + customCss: ["./src/tailwind.css"], + }), + tailwind({ applyBaseStyles: false }), + ], +}) diff --git a/docs/bun.lockb b/docs/bun.lockb new file mode 100755 index 0000000..c38af19 Binary files /dev/null and b/docs/bun.lockb differ diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..839f89f --- /dev/null +++ b/docs/package.json @@ -0,0 +1,26 @@ +{ + "name": "docs", + "type": "module", + "version": "0.0.1", + "scripts": { + "dev": "astro dev", + "start": "astro dev", + "build": "astro check && astro build", + "preview": "astro preview", + "astro": "astro" + }, + "dependencies": { + "@astrojs/starlight": "^0.26.1", + "@astrojs/starlight-tailwind": "^2.0.3", + "@astrojs/tailwind": "^5.1.0", + "astro": "^4.10.2", + "sharp": "^0.32.5", + "tailwindcss": "^3.4.4", + "@astrojs/check": "^0.9.3", + "typescript": "^5.5.4" + }, + "devDependencies": { + "prettier-plugin-astro": "^0.14.1", + "prettier-plugin-tailwindcss": "^0.6.6" + } +} \ No newline at end of file diff --git a/docs/public/favicon.svg b/docs/public/favicon.svg new file mode 100644 index 0000000..cba5ac1 --- /dev/null +++ b/docs/public/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/src/assets/houston.webp b/docs/src/assets/houston.webp new file mode 100644 index 0000000..930c164 Binary files /dev/null and b/docs/src/assets/houston.webp differ diff --git a/docs/src/assets/logo-dark.svg b/docs/src/assets/logo-dark.svg new file mode 100644 index 0000000..757e7e4 --- /dev/null +++ b/docs/src/assets/logo-dark.svg @@ -0,0 +1,23 @@ + + pesde + + + + + + diff --git a/docs/src/assets/logo-light.svg b/docs/src/assets/logo-light.svg new file mode 100644 index 0000000..b2c73bf --- /dev/null +++ b/docs/src/assets/logo-light.svg @@ -0,0 +1,23 @@ + + pesde + + + + + + diff --git a/docs/src/components/SiteTitle.astro b/docs/src/components/SiteTitle.astro new file mode 100644 index 0000000..c3da7d5 --- /dev/null +++ b/docs/src/components/SiteTitle.astro @@ -0,0 +1,30 @@ +
+ + + pesde + + + + + + + + / + docs +
diff --git a/docs/src/content/config.ts b/docs/src/content/config.ts new file mode 100644 index 0000000..45f60b0 --- /dev/null +++ b/docs/src/content/config.ts @@ -0,0 +1,6 @@ +import { defineCollection } from 'astro:content'; +import { docsSchema } from '@astrojs/starlight/schema'; + +export const collections = { + docs: defineCollection({ schema: docsSchema() }), +}; diff --git a/docs/src/content/docs/guides/getting-started.md b/docs/src/content/docs/guides/getting-started.md new file mode 100644 index 0000000..8e55f37 --- /dev/null +++ b/docs/src/content/docs/guides/getting-started.md @@ -0,0 +1,6 @@ +--- +title: Getting Started +description: pesde is very good +--- + +pesdies diff --git a/docs/src/content/docs/reference/configuration.md b/docs/src/content/docs/reference/configuration.md new file mode 100644 index 0000000..8f99ad0 --- /dev/null +++ b/docs/src/content/docs/reference/configuration.md @@ -0,0 +1,6 @@ +--- +title: Configuration Reference +description: Reference for `pesde.toml` +--- + +tomlies diff --git a/docs/src/env.d.ts b/docs/src/env.d.ts new file mode 100644 index 0000000..acef35f --- /dev/null +++ b/docs/src/env.d.ts @@ -0,0 +1,2 @@ +/// +/// diff --git a/docs/src/tailwind.css b/docs/src/tailwind.css new file mode 100644 index 0000000..a5ca780 --- /dev/null +++ b/docs/src/tailwind.css @@ -0,0 +1,11 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; + +:root[data-theme="light"] { + --sl-color-bg: rgb(255 245 230); +} + +:root[data-theme="light"] .sidebar-pane { + background-color: var(--sl-color-bg); +} diff --git a/docs/tailwind.config.ts b/docs/tailwind.config.ts new file mode 100644 index 0000000..77d7318 --- /dev/null +++ b/docs/tailwind.config.ts @@ -0,0 +1,36 @@ +import type { Config } from "tailwindcss" +import starlightPlugin from "@astrojs/starlight-tailwind" +import defaultTheme from "tailwindcss/defaultTheme" + +export default { + content: ["./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}"], + + theme: { + extend: { + fontFamily: { + sans: ["Nunito Sans Variable", ...defaultTheme.fontFamily.sans], + }, + colors: { + accent: { + 200: "rgb(241 157 30)", + 600: "rgb(120 70 10)", + 900: "rgb(24 16 8)", + 950: "rgb(10 7 4)", + }, + gray: { + 100: "rgb(245 230 210)", + 200: "rgb(228 212 192)", + 300: "rgb(180 160 140)", + 400: "rgb(130 90 40)", + 500: "rgb(84 70 50)", + 600: "rgb(65 50 41)", + 700: "rgb(50 42 35)", + 800: "rgb(28 22 17)", + 900: "rgb(10 7 4)", + }, + }, + }, + }, + + plugins: [starlightPlugin()], +} as Config diff --git a/docs/tsconfig.json b/docs/tsconfig.json new file mode 100644 index 0000000..77da9dd --- /dev/null +++ b/docs/tsconfig.json @@ -0,0 +1,3 @@ +{ + "extends": "astro/tsconfigs/strict" +} \ No newline at end of file