-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
13 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1 @@ | ||
| # Accessible Astro Starter | ||
|
|
||
|  | ||
|
|
||
| Accessible Astro Starter is a ready to use, SEO and a11y friendly blogging theme. It contains plenty of accessible components to build several page types, Tailwind CSS to help you build faster and example pages such as a dynamic Blog, 404, Markdown and MDX. This theme is designed to help you build your project faster and provide a solid base for accessibility! | ||
|
|
||
| 🚀 [Live Preview](https://accessible-astro.netlify.app/) | ||
|
|
||
| ## ♿ (Accessibility) Features | ||
|
|
||
| - Astro 4.0 | ||
| - Tailwind CSS support | ||
| - Prettier integration with `prettier-plugin-astro` and `prettier-plugin-tailwind` | ||
| - ESLint integration with strict accessibility settings for `eslint-plugin-jsx-a11y` | ||
| - Markdown and MDX support with examples included in the theme | ||
| - Uses the awesome `astro-icon` package for the icons | ||
| - Excellent Lighthouse/PageSpeed scores | ||
| - Accessible landmarks such as `header`, `main`, `footer`, `section` and `nav` | ||
| - Outline focus indicator which works on dark and light backgrounds | ||
| - Several `aria` attributes which provide a better experience for screen reader users | ||
| - `[...page].astro` and `[post].astro` demonstrate the use of dynamic routes and provide a basic blog with breadcrumbs and pagination | ||
| - `404.astro` provides a custom 404 error page which you can adjust to your needs | ||
| - `Header.astro` component included in the `DefaultLayout.astro` layout | ||
| - `Footer.astro` component included in the `DefaultLayout.astro` layout | ||
| - `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 mobile navigation | ||
| - `DarkMode.astro` component toggle with accessible button and a user system preferred color scheme setting | ||
| - `SiteMeta.astro` SEO component for setting custom meta data on different pages | ||
| - `.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 | ||
| - Ships with many components such as Accordions, Breadcrumbs, Modals, Pagination [and many more](https://accessible-astro.dev/accessible-components) | ||
| - A collection of utility classes such as breakpoints, button classes, font settings, resets and outlines in `src/assets/scss/base` | ||
| - View Transitions (⚠️ see [astro-docs](https://docs.astro.build/en/guides/view-transitions/#accessibility) for accessibility considerations) | ||
|
|
||
| ## 🚀 Getting started | ||
|
|
||
| Clone this theme locally and run any of the following commands in your 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 | | ||
|
|
||
| ## 📦 Other Accessible Astro projects | ||
|
|
||
| - [Accessible Astro Dashboard](https://github.com/markteekman/accessible-astro-dashboard/) | ||
| - [Accessible Astro Components](https://github.com/markteekman/accessible-astro-components/) | ||
|
|
||
| ## ❤️ Helping out | ||
|
|
||
| If you find that something isn't working right then I'm always happy to hear it to improve this starter! You can contribute in many ways and forms. Let me know by either: | ||
|
|
||
| 1. [Filing an issue](https://github.com/markteekman/accessible-astro-starter/issues) | ||
| 2. [Submitting a pull request](https://github.com/markteekman/accessible-astro-starter/pulls) | ||
| 3. [Starting a discussion](https://github.com/markteekman/accessible-astro-starter/discussions) | ||
| 4. [Buying me a coffee!](https://www.buymeacoffee.com/markteekman) | ||
|
|
||
| ## ☕ Thank you! | ||
|
|
||
| A big thank you to the creators of the awesome Astro static site generator and to all using this starter to make the web a bit more accessible for all people around the world :) | ||
|
|
||
| [](https://www.buymeacoffee.com/markteekman) | ||
| hi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| layout: ../../layouts/MarkdownLayout.astro | ||
| title: Just another blog | ||
| description: And how it was made | ||
| image: astro_mdx.png | ||
| --- | ||
|
|
||
| # Just another blog | ||
|
|
||
| First up welcome to my blog! I'm going to be using this space to write about things i learn. Mostly nerd stuff stuff like programming or how to make that perfect cup of coffee. | ||
|
|
||
| ### Why yet another blog? |