Initial commit

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,4 @@
+dist
+node_modules
+.github
+.changeset

.eslintrc.js

@@ -0,0 +1,60 @@
+/** @type {import("@types/eslint").Linter.Config} */
+module.exports = {
+	ignorePatterns: ["node_modules", "dist"],
+	root: true,
+	env: {
+		node: true,
+	},
+	parser: "@typescript-eslint/parser",
+	plugins: ["@typescript-eslint", "prettier"],
+	extends: [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/recommended",
+		"plugin:prettier/recommended",
+		"plugin:astro/recommended",
+		"plugin:astro/jsx-a11y-recommended",
+	],
+	overrides: [
+		{
+			files: ["*.astro"],
+			parser: "astro-eslint-parser",
+			parserOptions: {
+				parser: "@typescript-eslint/parser",
+				extraFileExtensions: [".astro"],
+			},
+			rules: {
+				"prettier/prettier": "off",
+				"import/no-named-as-default-member": "off",
+				"import/no-named-as-default": "off",
+				"@typescript-eslint/consistent-type-imports": "error",
+				"@typescript-eslint/no-unused-vars": "off",
+			},
+		},
+		{
+			files: ["**/*.mjs"],
+			parserOptions: {
+				sourceType: "module",
+				ecmaVersion: 2015,
+			},
+			rules: {
+				"import/no-extraneous-dependencies": "off",
+				"import/no-unresolved": "off",
+			},
+		},
+		{
+			files: ["**/*.ts"],
+			parser: "@typescript-eslint/parser",
+			extends: ["plugin:@typescript-eslint/recommended"],
+			rules: {
+				"@typescript-eslint/no-unused-vars": [
+					"error",
+					{ argsIgnorePattern: "^_", destructuredArrayIgnorePattern: "^_" },
+				],
+				"@typescript-eslint/no-non-null-assertion": "off",
+			},
+		},
+	],
+	rules: {
+		"@typescript-eslint/no-var-requires": "warn",
+	},
+};

.github/workflows/stale.yml

@@ -0,0 +1,33 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '39 23 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v7
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'
+        stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
+        stale-pr-message: "This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
+        close-issue-message: "This issue was closed because it has been stalled for 5 days with no activity."
+        days-before-stale: 30
+        days-before-close: 5
+        days-before-pr-close: -1
+        exempt-issue-labels: "not-stale,bug,pinned,security,pending,awaiting-approval,work-in-progress"
+        exempt-pr-labels: "not-stale,bug,pinned,security,pending,awaiting-approval,work-in-progress"

.gitignore

@@ -0,0 +1,25 @@
+# build output
+dist/
+.output/
+
+# 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
+
+# misc
+*.pem
+.cache
+.astro

.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true

.nvmrc

@@ -0,0 +1 @@
+18.12.1

.prettierignore

@@ -0,0 +1,32 @@
+*.min.js
+**/node_modules/**
+flow-typed
+
+# webfont demo styles
+**/specimen_files
+
+# built sites
+benchmarks/**/public
+e2e-tests/**/public
+examples/**/public
+integration-tests/**/public
+www/public
+
+# cache-dirs
+**/.cache
+
+# ignore built packages
+packages/**/*.js
+!packages/*/src/**/*.js
+
+# fixtures
+**/__testfixtures__/**
+**/__tests__/fixtures/**
+
+infrastructure
+
+# coverage
+coverage
+
+pnpm-lock.yaml
+dist

.prettierrc.js

@@ -0,0 +1,21 @@
+/** @type {import("@types/prettier").Options} */
+module.exports = {
+	printWidth: 100,
+	semi: true,
+	singleQuote: false,
+	tabWidth: 2,
+	useTabs: true,
+	plugins: [
+		require("prettier-plugin-astro"),
+		require("prettier-plugin-tailwindcss") /* Must come last */,
+	],
+	pluginSearchDirs: false,
+	overrides: [
+		{
+			files: "**/*astro",
+			options: {
+				parser: "astro",
+			},
+		},
+	],
+};

.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+	"recommendations": ["astro-build.astro-vscode"],
+	"unwantedRecommendations": []
+}

.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"
+		}
+	]
+}

.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+	"editor.formatOnSave": true,
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": true
+	},
+	"[markdown]": {
+		"editor.wordWrap": "on",
+		"editor.codeActionsOnSave": {
+			"source.fixAll.markdownlint": true
+		}
+	},
+	"prettier.documentSelectors": ["**/*.astro"],
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"astro", // Enable .astro
+		"typescript", // Enable .ts
+		"typescriptreact"
+	]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Chris Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,136 @@
+<div align="center">
+  <img alt="Astro Theme Cactus logo" src="./gh-assets/astro-cactus-logo.png" width="70" />
+</div>
+<h1 align="center">
+  🚀 Astro Theme Cactus 🌵
+</h1>
+
+Astro Theme Cactus is a simple opinionated starter built with the Astro framework. Use it to create an easy-to-use blog or website.
+
+## Key Features
+
+- Astro Fast 🚀
+- TailwindCSS Utility classes
+- Accessible, semantic HTML markup
+- Responsive & SEO-friendly
+- Dark / Light mode, using Tailwind and CSS variables
+- [Astro Assets Integration](https://docs.astro.build/en/guides/assets/) for optimised images
+- MD & [MDX](https://docs.astro.build/en/guides/markdown-content/#mdx-only-features) posts
+- [Satori](https://github.com/vercel/satori) for creating open graph png images
+- Pagination
+- [Automatic RSS feed](https://docs.astro.build/en/guides/rss)
+- Shiki code syntax styling
+- Auto-generated [sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)
+- [Pagefind](https://pagefind.app/) static search library integration
+
+## Demo 💻
+
+Check out the [Demo](https://astro-theme-cactus.netlify.app/), hosted on Netlify
+
+## Quick start
+
+[Create a new repo](https://github.com/chrismwilliams/astro-theme-cactus/generate) from this template.
+
+[![Deploy with Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/chrismwilliams/astro-theme-cactus) [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fchrismwilliams%2Fastro-theme-cactus&project-name=astro-theme-cactus)
+
+## Commands
+
+Replace pnpm with your choice of npm / yarn
+
+| Command          | Action                                                         |
+| :--------------- | :------------------------------------------------------------- |
+| `pnpm install`   | Installs dependencies                                          |
+| `pnpm dev`       | Starts local dev server at `localhost:3000`                    |
+| `pnpm build`     | Build your production site to `./dist/`                        |
+| `pnpm postbuild` | Pagefind script to build the static search of your blog posts  |
+| `pnpm preview`   | Preview your build locally, before deploying                   |
+| `pnpm sync`      | Generate types based on your config in `src/content/config.ts` |
+
+## Configure
+
+- Edit the config file `src/site.config.ts` for basic site meta data
+- Update file `astro.config.ts` site property with your own domain
+- Replace & update files within the `/public` folder:
+  - favicon.ico & other social icons
+  - robots.txt - update the Sitemap url to your own domain
+  - manifest.webmanifest
+- Modify file `src/styles/global.css` with your own light and dark styles
+- Edit social links in `src/data/constants.ts` and in turn `src/components/SocialList.astro` to add/replace your media profile. Icons used can be found @ [tablericons](https://tablericons.com/)
+- Create / edit posts for your blog within `src/content/post/` with .md/mdx file(s). See [below](#adding-posts) for more details.
+- OG Image:
+  - If you would like to change the style of the generated image the Satori library creates, open up `src/pages/og-image/[slug].png.ts` to the markup function where you can edit the html/tailwind-classes as necessary. You can also use this [satori playground](https://og-playground.vercel.app/) to aid your design.
+  - If you would like to generate svg og images rather than the default .png ones, you will need to remove the @resvg/resvg-js library, and return the svg within the body of the get function from the file `src/pages/og-image/[slug].png.ts`.
+  - You can also create your own og images and skip satori generating if for you by adding an ogImage property in the frontmatter with a link to the asset, an example can be found in `src/content/post/social-image.md`. More info on frontmatter can be found [here](#frontmatter)
+- Optional:
+  - Fonts: This theme sets the body element to the font family `font-mono`, located in the global css file `src/styles/global.css`. You can change fonts by removing the variant `font-mono`, after which TailwindCSS will default to the `font-sans` [font family stack](https://tailwindcss.com/docs/font-family).
+
+## Adding posts
+
+This theme utilises [Content Collections](https://docs.astro.build/en/guides/content-collections/) to organise Markdown and/or MDX files, as well as type-checking frontmatter with a schema -> `src/content/config.ts`.
+
+Adding a post is a simple as adding your .md(x) file(s) to the `src/content/post` folder, the filename of which will be used as the slug/url. The two posts included with this template are there as an example of how to structure your frontmatter. Additionally, the [Astro docs](https://docs.astro.build/en/guides/markdown-content/) has a detailed section on markdown pages.
+
+### Frontmatter
+
+| Property (\* required) | Description                                                                                                                                                                                                                                                                                       |
+| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| title \*               | Self explanatory. Used as the text link to the post, the h1 on the posts' page, and the pages title property. Has a max length of 60 chars, set in `src/content/config.ts`                                                                                                                        |
+| description \*         | Similar to above, used as the seo description property. Has a min length of 50 and a max length of 160 chars, set in the post schema.                                                                                                                                                             |
+| publishDate \*         | Again pretty simple. To change the date format/locale, currently **en-GB**, update/pass the **locale** arg to function **getFormattedDate**, found in `src/utils/date.ts`.                                                                                                                        |
+| tags                   | Tags are optional with any created post. Any new tag(s) will be shown in `yourdomain.com/posts` + `yourdomain.com/tags`, and generate the page(s) `yourdomain.com/tags/[yourTag]`                                                                                                                 |
+| coverImage             | This is an optional object that will add a cover image to the top of a post. Include both a `src`: "_path-to-image_" and `alt`: "_image alt_". You can view an example in `src/content/post/cover-image.md`                                                                                       |
+| ogImage                | This is an optional property. An OG Image will be generated automatically for every post where this property **isn't** provided. If you would like to create your own for a specific post, include this property and a link to your image, the theme will then skip automatically generating one. |
+
+## Pagefind search
+
+This integration brings a static search feature for searching blog posts. In its current form, pagefind only works once the site has been built. This theme adds a postbuild script that should be run after Astro has built the site. You can preview locally by running both build && postbuild.
+
+Search results only includes blog posts. If you would like to include other/all your pages, remove/re-locate the attribute `data-pagefind-body` to the article tag found in `src/layouts/BlogPost.astro`.
+
+It also allows you to filter posts by tags added in the frontmatter of blog posts. If you would rather remove this, remove the data attribute `data-pagefind-filter="tag"` from the link in `src/components/blog/Hero.astro`.
+
+Note the current build will display a warning in the console, you can follow this issue [here](https://github.com/CloudCannon/pagefind/issues/290)
+
+If you would rather not include this integration, simply remove the component `src/components/Search.astro`, and uninstall both `@pagefind/default-ui` & `pagefind` from package.json. You will also need to remove the postbuild script from here as well.
+
+## Analytics
+
+You may want to track the number of visitors you receive to your blog/website in order to understand trends and popular posts/pages you've created. There are a number of providers out there one could use, including web hosts such as [vercel](https://vercel.com/analytics), [netlify](https://www.netlify.com/products/analytics/), and [cloudflare](https://www.cloudflare.com/web-analytics/).
+
+This theme/template doesn't include a specific solution due to there being a number of use cases and/or options which some people may or may not use.
+
+You may be asked to included a snippet inside the **HEAD** tag of your website when setting it up, which can be found in `src/layouts/Base.astro`. Alternatively, you could add the snippet in `src/components/BaseHead.astro`.
+
+Another popular provider is google analytics which you could integrate via the above method, or, for example adding [astro-google-analytics](https://www.npmjs.com/package/astro-google-analytics)
+
+```bash
+pnpm install astro-google-analytics
+```
+
+Edit `src/layouts/Base.astro`, and add:
+
+```astro
+---
+import { GoogleAnalytics } from "astro-google-analytics";
+// ...other imports
+---
+
+<head>
+	<!-- Replace id with your own Google Analytics ID -->
+	<GoogleAnalytics id="G-XXXXXXXXXX" />
+</head>
+```
+
+## Deploy
+
+[Astro docs](https://docs.astro.build/en/guides/deploy/) has a great section and breakdown of how to deploy your own Astro site on various platforms and their idiosyncrasies.
+
+By default the site will be built (see [Commands](#commands) section above) to a `/dist` directory.
+
+## Acknowledgment
+
+This theme is inspired by [Hexo Theme Cactus](https://github.com/probberechts/hexo-theme-cactus)
+
+## License
+
+MIT