astro-hashnode/package/README.md

78 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

# Astro Hashnode
2024-03-11 09:34:55 +00:00
An Integration to bring your Hashnode Headless Blog content into Astro!
2024-03-11 09:34:55 +00:00
## Installation
Install the integration **automatically** using the Astro CLI:
```bash
pnpm astro add @matthiesenxyz/astro-hashnode
2024-03-11 09:34:55 +00:00
```
```bash
npx astro add @matthiesenxyz/astro-hashnode
2024-03-11 09:34:55 +00:00
```
```bash
yarn astro add @matthiesenxyz/astro-hashnode
2024-03-11 09:34:55 +00:00
```
Or install it **manually**:
1. Install the required dependencies
```bash
pnpm add @matthiesenxyz/astro-hashnode
2024-03-11 09:34:55 +00:00
```
```bash
npm install @matthiesenxyz/astro-hashnode
2024-03-11 09:34:55 +00:00
```
```bash
yarn add @matthiesenxyz/astro-hashnode
2024-03-11 09:34:55 +00:00
```
2. Add the integration to your astro config
```diff
+import astroHashnode from "@matthiesenxyz/astro-hashnode";
2024-03-11 09:34:55 +00:00
export default defineConfig({
integrations: [
+ astroHashnode({
+ hashnodeURL: 'astroplayground.hashnode.dev'
}),
2024-03-11 09:34:55 +00:00
],
});
```
## Full Configuration Options
2024-03-11 09:34:55 +00:00
```ts
astroHashnode({
hashnodeURL: 'astroplayground.hashnode.dev', // Your hashnode URL
landingPage: true, // Lets you disable the default landing page!
useViewTransitions: true, // Lets you enable/disable the default included ViewTransitions.
layoutComponent: './src/layouts/YourLayout.astro' // Lets you change the default Layout.astro being used by the Integration Pages.
verbose: false // Change to Verbose console output
})
2024-03-11 09:34:55 +00:00
```
Node: This Integration uses the new Tailwind v4 There is no config options in this version of tailwindCSS, and applyBaseStyles is enabled! So if you are building your own LayoutComponent feel free to use TailwindCSS!
2024-03-11 09:34:55 +00:00
## Licensing
[MIT Licensed](./LICENSE). Made with ❤️ by [Adam M.](https://github.com/AdamMatthiesen).
## Acknowledgements
- [`astro-integration-kit`](https://github.com/florian-lefebvre/astro-integration-kit) by Florian
- [`Hashnode - HeadlessCMS`](https://hashnode.com/headless) by the Hashnode
- [`TailwindCSS v4`](https://tailwindcss.com/blog/tailwindcss-v4-alpha) by the TailwindCSS team
- [`Astro-Font`](https://github.com/rishi-raj-jain/astro-font) by Rishi
- [`Astro-SEO`](https://github.com/jonasmerlin/astro-seo) by Jonas
2024-03-11 13:15:37 +00:00
- [`Astro-Remote`](https://github.com/natemoo-re/astro-remote) by Nate