Merge pull request #30 from markteekman/develop

Develop

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Mark Teekman
+
+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

@@ -1,6 +1,6 @@
 # Accessible Astro Starter
 
-This starter project is build upon the (awesome) [Astro Static Site Builder](https://astro.build/). This starter offers a couple of Accessibility components and some utility classes to get you building your project faster. Also check out the [Accessible Astro Components](https://github.com/markteekman/accessible-astro-components) npm package which can be used with (or without) this starter!
+This starter project is build upon the (awesome) [Astro Static Site Builder](https://astro.build/). This starter offers a couple of Accessibility components, a couple of example pages, a blog with dynamic routes, a custom 404 page and some utility classes to get you building your project faster. Also check out the [Accessible Astro Components](https://github.com/markteekman/accessible-astro-components) npm package which can be used with (or without) this starter!
 
 [Live demo](https://starter.accessible-astro.dev)
 
@@ -14,19 +14,21 @@ npm install && npm start
 
 In this starter you'll find a couple of things:
 
-- Accessible landmarks in the `DefaultLayout.astro` file such as `header`, `main` and `footer`
-- Accessible landmark examples in the `index.astro` file such as `section` and `nav`
+- Accessible landmarks such as `header`, `main`, `footer`, `section` and `nav`
+- Outline focus indicator which works on dark and light backgrounds
 - `SkipLinks.astro` component to skip to either the main menu or the main content
 - `Navigation.astro` component with keyboard accessible (dropdown) navigation (arrow keys, escape key)
 - `ResponsiveToggle.astro` component with an accessible responsive toggle button for the navigation
 - `DarkMode.astro` component toggle with accessible button and a user system preferred color scheme
-- Outline focus indicator which works on dark and light backgrounds
-- `.sr-only` token class for screen reader only text content
+- `.sr-only` utility class for screen reader only text content (hides text visually)
 - `prefers-reduced-motion` disables animations for users that have this preference turned on
 
 ## Extra features
 
-- Comes with a demo blog which is rendered using fetched data and the Accessible Astro Card Component
+- `blog.astro` and `posts/[id].astro` demonstrate the use of dynamic routes and provide a basic blog
+- `404.astro` provides a custom 404 error page which you can adjust to your needs
+- [Accessible Astro Components](https://github.com/markteekman/accessible-astro-components) package comes preinstalled with extra components such as Accordions, Modals and Notifications
+- Nate Moore's awesome [Astro Icon](https://github.com/natemoo-re/astro-icon) package is also preinstalled which can be applied to different use cases
 
 ## Utilities
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "accessible-astro-starter",
   "description": "An Accessible Starter Theme for Astro including several accessiblity features and tools to help you build faster.",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "author": "Mark Teekman",
   "homepage": "https://accessible-astro.dev",
   "scripts": {

src/layouts/DefaultLayout.astro

@@ -25,8 +25,8 @@ let subtitle = 'Accessible Astro Starter'
     <meta property="og:title" content="Accessible Astro Starter">
     <meta property="og:description" content="A starter project with accessible features using Astro static site builder. Contains accessible landmarks, skip links, a dark mode color scheme, better focus outline and keyboard menu navigation.">
     <meta property="og:type" content="website">
-    <meta property="og:url" content="https://accessible-astro.markteekman.nl/">
-    <meta property="og:image" content="assets/social-preview-image.png">
+    <meta property="og:url" content="https://starter.accessible-astro.dev">
+    <meta property="og:image" content="/social-preview-image.png">
 
     <!-- page title -->
     <title>{title} - {subtitle}</title>