Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hendriknielaender/double-trouble
Dev Blog
https://github.com/hendriknielaender/double-trouble
astro blog dev
Last synced: 3 months ago
JSON representation
Dev Blog
- Host: GitHub
- URL: https://github.com/hendriknielaender/double-trouble
- Owner: hendriknielaender
- License: mit
- Created: 2022-10-14T18:59:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T03:33:45.000Z (9 months ago)
- Last Synced: 2024-04-22T04:10:02.779Z (9 months ago)
- Topics: astro, blog, dev
- Language: Astro
- Homepage: https://double-trouble.dev
- Size: 28.6 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤜🤛 Double Trouble Blog
## Preview Images
Preview images created with Dall e https://openai.com/dall-e-2/
Queries:
- a cute orange colored fox is riding into the sun on a cloud with an army of small clones of himself behind him on other clouds in a formation, digital art
### Image Credit Approach
Should attribute the original owner of the image and respect the license of the image.
## Analytics
[Usermaven](https://usermaven.com/) is used for analytics. It is GDPR conform, does not collect
PII and stores data only in the EU.
We use it in a configuration that follows a strict data policy by not using [cookies](https://usermaven.com/docs/getting-started/installing-usermaven#what-is-cookieless-tracking-and-how-to-enable-it).
## AstroWind Theme
### Features
- ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)) supporting **Dark mode**.
- ✅ **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports.
- ✅ **Fast and SEO friendly blog** with automatic **RSS feed** ([@astrojs/rss](https://docs.astro.build/en/guides/rss/)), [**MDX** support](https://docs.astro.build/en/guides/integrations-guide/mdx/), **Categories & Tags**, **Social Share** buttons, ...
- ✅ **Image optimization** ([@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/)) and **Font optimization**.
- ✅ Generation of **project sitemap** based on your routes ([@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)).
- ✅ **Open Graph tags** for social media sharing.
- ✅ **Analytics** built-in Google Analytics, and Splitbee integration.
[](https://github.com/onwidget/astrowind/blob/main/LICENSE.md)
[](https://github.com/onwidget)
[](https://github.com/onwidget/astrowind#contributing)
[](https://snyk.io/test/github/onwidget/astrowind)
Table of Contents
- [Demo](#demo)
- [Getting started](#getting-started)
- [Project structure](#project-structure)
- [Commands](#commands)
- [Configuration](#configuration)
- [Deploy](#deploy)
- [Roadmap](#roadmap)
- [Frequently Asked Questions](#frequently-asked-questions)
- [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](https://astro.build/) + [Tailwind CSS](https://tailwindcss.com/). It's a free theme 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, Angular, 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:
```
/
├── data/
| └── blog/
| ├── post-slug-1.md
| ├── post-slug-2.mdx
| └── ...
├── public/
│ ├── robots.txt
│ └── favicon.ico
├── src/
│ ├── assets/
│ │ ├── images/
| | └── styles/
| | └── base.css
│ ├── components/
│ │ ├── atoms/
│ │ ├── blog/
│ │ ├── core/
| | └── widgets/
| | ├── Header.astro
| | ├── Footer.astro
| | └── ...
│ ├── layouts/
│ | |── BaseLayout.astro
│ | └── ...
│ ├── pages/
│ | ├── [...blog]/
| | | ├── [...page].astro
| | | └── [slug].astro
│ | ├── [...categories]/
| | | └── [category]/
| | | └── [...page].astro
│ | ├── [...tags]/
| | | └── [tag]/
| | | └── [...page].astro
│ | ├── index.astro
| | ├── 404.astro
| | └-- rss.xml.js
│ ├── utils/
│ └── config.mjs
├── package.json
└── ...
```
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.
[](https://githubbox.com/onwidget/astrowind/tree/main)
> 🧑🚀 **Seasoned astronaut?** Delete this file. Update `config.mjs` 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.mjs`
```javascript
export const SITE = {
name: 'Example',
origin: 'https://example.com',
basePathname: '/', // Change this if you need to deploy to Github Pages, for example
trailingSlash: false, // Generate permalinks with or without "/" at the end
title: 'Example - This is the homepage title of Example',
description: 'This is the homepage description of Example',
googleAnalyticsId: false, // or "G-XXXXXXXXXX",
googleSiteVerificationId: false, // or some value,
};
export const BLOG = {
disabled: false,
postsPerPage: 4,
blog: {
disabled: false,
pathname: 'blog', // blog main path, you can change this to "articles" (/articles)
},
post: {
disabled: false,
pathname: '', // empty for /some-post, value for /pathname/some-post
},
category: {
disabled: false,
pathname: 'category', // set empty to change from /category/some-category to /some-category
},
tag: {
disabled: false,
pathname: 'tag', // set empty to change from /tag/some-tag to /some-tag
},
};
```