From ec87c05f18d547dba84c8d98951a45da7bbc0565 Mon Sep 17 00:00:00 2001 From: Toastie Date: Sat, 20 Jan 2024 22:22:38 +1300 Subject: [PATCH] Updated stuff --- README.md | 276 +----------------------------------------------- src/config.yaml | 4 +- 2 files changed, 5 insertions(+), 275 deletions(-) diff --git a/README.md b/README.md index 45209f9..cee15a7 100644 --- a/README.md +++ b/README.md @@ -1,275 +1,5 @@ -# 🚀 AstroWind +# DragonsChild -AstroWind Lighthouse Score +## Live link -🌟 _Most *starred* & *forked* Astro theme in 2022 & 2023_. 🌟 - -**AstroWind** is a free and open-source template to make your website using **[Astro 4.0](https://astro.build/) + [Tailwind CSS](https://tailwindcss.com/)**. Ready to start a new project and designed taking into account web best practices. - -- ✅ **Production-ready** scores in **PageSpeed Insights** reports. -- ✅ Integration with **Tailwind CSS** supporting **Dark mode** and **_RTL_**. -- ✅ **Fast and SEO friendly blog** with automatic **RSS feed**, **MDX** support, **Categories & Tags**, **Social Share**, ... -- ✅ **Image Optimization** (using new **Astro Assets** and **Unpic** for Universal image CDN). -- ✅ Generation of **project sitemap** based on your routes. -- ✅ **Open Graph tags** for social media sharing. -- ✅ **Analytics** built-in Google Analytics, and Splitbee integration. - -
- -AstroWind Theme Screenshot - -[![onWidget](https://custom-icon-badges.demolab.com/badge/made%20by%20-onWidget-556bf2?style=flat-square&logo=onwidget&logoColor=white&labelColor=101827)](https://onwidget.com) -[![License](https://img.shields.io/github/license/onwidget/astrowind?style=flat-square&color=dddddd&labelColor=000000)](https://github.com/onwidget/astrowind/blob/main/LICENSE.md) -[![Maintained](https://img.shields.io/badge/maintained%3F-yes-brightgreen.svg?style=flat-square)](https://github.com/onwidget) -[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](https://github.com/onwidget/astrowind#contributing) -[![Known Vulnerabilities](https://snyk.io/test/github/onwidget/astrowind/badge.svg?style=flat-square)](https://snyk.io/test/github/onwidget/astrowind) -[![Stars](https://img.shields.io/github/stars/onwidget/astrowind.svg?style=social&label=stars&maxAge=86400&color=ff69b4)](https://github.com/onwidget/astrowind) -[![Forks](https://img.shields.io/github/forks/onwidget/astrowind.svg?style=social&label=forks&maxAge=86400&color=ff69b4)](https://github.com/onwidget/astrowind) - -
- -
-Table of Contents - -- [Demo](#demo) -- [Getting started](#getting-started) - - [Project structure](#project-structure) - - [Commands](#commands) - - [Configuration](#configuration) - - [Deploy](#deploy) -- [Frequently Asked Questions](#frequently-asked-questions) -- [Related Projects](#related-projects) -- [Contributing](#contributing) -- [Acknowledgements](#acknowledgements) -- [License](#license) - -
- -
- -## Demo - -📌 [https://astrowind.vercel.app/](https://astrowind.vercel.app/) - -
- -## Getting started - -**AstroWind** tries to give you quick access to creating a website using [Astro 4.0](https://astro.build/) + [Tailwind CSS](https://tailwindcss.com/). It's a free theme which focuses on simplicity, good practices and high performance. - -Very little vanilla javascript is used only to provide basic functionality so that each developer decides which framework (React, Vue, Svelte, Solid JS...) to use and how to approach their goals.. - -### Project structure - -Inside **AstroWind** template, you'll see the following folders and files: - -``` -/ -├── public/ -│ ├── _headers -│ └── robots.txt -├── src/ -│ ├── assets/ -│ │ ├── favicons/ -│ │ ├── images/ -│ │ └── styles/ -│ │ └── tailwind.css -│ ├── components/ -│ │ ├── blog/ -│ │ ├── common/ -│ │ ├── ui/ -│ │ ├── widgets/ -│ │ │ ├── Header.astro -│ │ │ └── ... -│ │ ├── CustomStyles.astro -│ │ ├── Favicons.astro -│ │ └── Logo.astro -│ ├── content/ -│ │ ├── post/ -│ │ │ ├── post-slug-1.md -│ │ │ ├── post-slug-2.mdx -│ │ │ └── ... -│ │ └-- config.ts -│ ├── layouts/ -│ │ ├── Layout.astro -│ │ ├── MarkdownLayout.astro -│ │ └── PageLayout.astro -│ ├── pages/ -│ │ ├── [...blog]/ -│ │ │ ├── [category]/ -│ │ │ ├── [tag]/ -│ │ │ ├── [...page].astro -│ │ │ └── index.astro -│ │ ├── index.astro -│ │ ├── 404.astro -│ │ ├-- rss.xml.ts -│ │ └── ... -│ ├── utils/ -│ ├── config.yaml -│ └── navigation.js -├── package.json -├── astro.config.mjs -└── ... -``` - -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. - -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. - -Any static assets, like images, can be placed in the `public/` directory if they do not require any transformation or in the `assets/` directory if they are imported directly. - - -[![Edit AstroWind on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://githubbox.com/onwidget/astrowind/tree/main) [![Open in Gitpod](https://svgshare.com/i/xdi.svg)](https://gitpod.io/?on=gitpod#https://github.com/onwidget/astrowind) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/onwidget/astrowind) - -> 🧑‍🚀 **Seasoned astronaut?** Delete this file `README.md`. Update `src/config.yaml` and contents. Have fun! - -
- -### 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:3000` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run format` | Format codes with Prettier | -| `npm run lint:eslint` | Run Eslint | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` | - -
- -### Configuration - -Basic configuration file: `./src/config.yaml` - -```yaml -site: - name: 'Example' - site: 'https://example.com' - base: '/' # Change this if you need to deploy to Github Pages, for example - trailingSlash: false # Generate permalinks with or without "/" at the end - - googleSiteVerificationId: false # Or some value, - -# Default SEO metadata -metadata: - title: - default: 'Example' - template: '%s — Example' - description: 'This is the default meta description of Example website' - robots: - index: true - follow: true - openGraph: - site_name: 'Example' - images: - - url: '~/assets/images/default.jpg' - width: 1200 - height: 628 - type: website - twitter: - handle: '@twitter_user' - site: '@twitter_user' - cardType: summary_large_image - -i18n: - language: en - textDirection: ltr - -apps: - blog: - isEnabled: true - postsPerPage: 6 - - post: - isEnabled: true - permalink: '/blog/%slug%' # Variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category% - robots: - index: true - - list: - isEnabled: true - pathname: 'blog' # Blog main path, you can change this to "articles" (/articles) - robots: - index: true - - category: - isEnabled: true - pathname: 'category' # Category main path /category/some-category, you can change this to "group" (/group/some-category) - robots: - index: true - - tag: - isEnabled: true - pathname: 'tag' # Tag main path /tag/some-tag, you can change this to "topics" (/topics/some-category) - robots: - index: false - -analytics: - vendors: - googleAnalytics: - id: null # or "G-XXXXXXXXXX" - -ui: - theme: 'system' # Values: "system" | "light" | "dark" | "light:only" | "dark:only" -``` - -
- -### Deploy - -#### Deploy to production (manual) - -You can create an optimized production build with: - -```shell -npm run build -``` - -Now, your website is ready to be deployed. All generated files are located at -`dist` folder, which you can deploy the folder to any hosting service you -prefer. - -#### Deploy to Netlify - -Clone this repository on own GitHub account and deploy to Netlify: - -[![Netlify Deploy button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/onwidget/astrowind) - -#### Deploy to Vercel - -Clone this repository on own GitHub account and deploy to Vercel: - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fonwidget%2Fastrowind) - -
- -## Frequently Asked Questions - -- Why? -- -- - -
- -## Related projects - -- [TailNext](https://tailnext.vercel.app/) - Free template using Next.js 14 and Tailwind CSS with the new App Router. -- [Qwind](https://qwind.pages.dev/) - Free template to make your website using Qwik + Tailwind CSS. - -## Contributing - -If you have any idea, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. -That would be very useful for all of us and we would be happy to listen and take action. - -## Acknowledgements - -Initially created by [onWidget](https://onwidget.com) and maintained by a community of [contributors](https://github.com/onwidget/astrowind/graphs/contributors). - -## License - -**AstroWind** is licensed under the MIT license — see the [LICENSE](./LICENSE.md) file for details. +https://dragonschildstudios.com/ diff --git a/src/config.yaml b/src/config.yaml index 189de40..8284807 100644 --- a/src/config.yaml +++ b/src/config.yaml @@ -19,8 +19,8 @@ metadata: site_name: Dragons child studios type: website twitter: - handle: '@onwidget' - site: '@onwidget' + handle: '@dragonschildstudios' + site: '@dragonschildstudios' cardType: summary_large_image i18n: