diff --git a/README.md b/README.md index cb40653c0..922486506 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ It's hugely inspired by [Hugo](https://github.com/knadh/hugo-ink)'s Ink theme an - __Dark Mode & Color Codes__ - It supports dark mode, and __6+__ color modes that's selected using `tailwind.config.js`. You can pass `THEME_KEY` with the `dev` or `build` script/commands ex: `THEME_KEY=purpleheart astro build/dev` to change the color theme being used. All the available themes can be found in [tailwind.theme.config.js](./tailwind.theme.config.js). To customize the blog section, add any of the Tailwind Typography's `prose-{color}` classes as referred [here](./src/components/Prose.astro) - __Netlify CMS__ - Add/Edit/Update all the posts in the `/blog` directory by visiting `your-site.netlify.com/admin` ex: [astro-ink.netlify.app/admin](https://astro-ink.netlify.app/admin) with your Netlify credentials. It needs Netlify Identity(https://app.netlify.com/sites/your-site/settings/identity#registration ) and Git Gateway(https://app.netlify.com/sites/your-site/settings/identity#services) enabled. -- __Future Posts__(with Github Actions) - Create posts in the `/src/drafts` directory with a future `date` in the `YYYY-MM-DD` format, and let a specially crafted [Github Action](https://github.com/marketplace/actions/ssg-publish-drafts) take care of auto-publishing it on your specified date. You can configure the check interval in [Github Action](https://github.com/one-aalam/astro-ink/blob/main/.github/workflows/main.yml). +- __Future Posts__ (with Github Actions) - Create posts in the `/src/drafts` directory with a future `date` in the `YYYY-MM-DD` format, and let a specially crafted [Github Action](https://github.com/marketplace/actions/ssg-publish-drafts) take care of auto-publishing it on your specified date. You can configure the check interval in [Github Action](https://github.com/one-aalam/astro-ink/blob/main/.github/workflows/main.yml). - __Client-Side Search__ - Allow your users get to your blog posts quickly with client-side search feat. Lunr.js - __View counter feat. Redis/Upstash Redis__ - Configure your Redis host, place it's connection URL in your hosting provider's console (Vercel, Netlify, etc.) or in a `.env` file(local development), un-comment the connection code [here](./src/pages/api/blog/views/[slug].ts) and deploy. Your site's powered with a dynamic views counter. See [.env.example](./.env.example) to understand the different environment values you need to configure. - __Media Page with YT channel support__ - Easily show your YT channel content on the media page by just putting your channel id in [config](./src/config.ts) file's `ytChannelId` constant. Optionally, disable the image thumbnails from your YT channel's video listing by setting `USE_MEDIA_THUMBNAIL` to `false`. @@ -40,8 +40,8 @@ It's hugely inspired by [Hugo](https://github.com/knadh/hugo-ink)'s Ink theme an **Note:** Use `npx degit one-aalam/astro-ink` to clone the template without any of the `git` history -**Note: This template genrates `server` (SSR ready) output by default. If you want `static` builds** - - change `output` to `static` from `server` in [astro.config.js](./astro.config.mjs) +**Note: This template generates `server` (SSR ready) output by default. If you want `static` builds** + - change `output` to `static` from `server` in [astro.config.mjs](./astro.config.mjs) - remove `adapter: vercel()` - remove the views counter [API](./src/pages/api/blog/views/[slug].json.ts) - set `USE_VIEW_STATS` to `false` inside [config.ts](./src/config.ts)