HackMD & Astro
यह कंटेंट अभी तक आपकी भाषा में उपलब्ध नहीं है।
HackMD is a collaborative Markdown editor and publishing platform. You can use its API to manage your content in HackMD and display it in your Astro project.
Integrating with Astro
Section titled “Integrating with Astro”This guide uses the official @hackmd/api client to fetch your notes and markdown-it to render Markdown content.
Prerequisites
Section titled “Prerequisites”To get started, you will need:
- An Astro project - If you don’t have an Astro project yet, the installation guide will get you up and running.
- A HackMD account - You can sign up for free.
- A HackMD access token - Create one from the API section of your HackMD settings.
- At least one publicly readable note - Set the note’s read permission to Everyone so the example can safely publish it on your site.
Setting up credentials
Section titled “Setting up credentials”Create a .env file in the root of your project and add your HackMD access token:
HACKMD_API_ACCESS_TOKEN=<YOUR_ACCESS_TOKEN>Do not prefix this variable with PUBLIC_. This keeps the token available only to your server-side code and prevents Astro from exposing it to the browser.
.env files in Astro.
Installing dependencies
Section titled “Installing dependencies”Install the HackMD API client and Markdown renderer:
npm install @hackmd/api markdown-itpnpm add @hackmd/api markdown-ityarn add @hackmd/api markdown-itConfiguring HackMD
Section titled “Configuring HackMD”Create a hackmd.ts file in a new src/lib/ directory. This file initializes the API client, renders Markdown, and creates a URL-friendly identifier for each note:
import { API } from '@hackmd/api';import MarkdownIt from 'markdown-it';
export const client = new API(import.meta.env.HACKMD_API_ACCESS_TOKEN);
const md = new MarkdownIt({ html: false, linkify: true, typographer: true,});
export function renderMarkdown(content: string) { return md.render(content);}
export function getNoteSlug(note: { permalink: string | null; shortId: string }) { return note.permalink ?? note.shortId;}The html: false option prevents raw HTML in a note from being passed directly to your generated page. Standard Markdown is still rendered as HTML.
Your project will use the following files:
Directorysrc/
Directorylib/
- hackmd.ts
Directorypages/
- index.astro
Directorynotes/
- [slug].astro
- .env
- astro.config.mjs
- package.json
Making a blog with Astro and HackMD
Section titled “Making a blog with Astro and HackMD”This example creates an index of publicly readable notes and a statically generated page for each note.
Displaying a list of notes
Section titled “Displaying a list of notes”Use getNoteList() in src/pages/index.astro to retrieve your notes. Filter the results so that only notes with the guest read permission are included in the public site:
---import { client, getNoteSlug } from '../lib/hackmd';
const notes = await client.getNoteList();const publicNotes = notes.filter((note) => note.readPermission === 'guest');---
<!doctype html><html lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width" /> <title>Astro + HackMD</title> </head> <body> <main> <h1>My HackMD notes</h1> <ul> { publicNotes.map((note) => ( <li> <a href={`/notes/${getNoteSlug(note)}/`}>{note.title}</a> </li> )) } </ul> </main> </body></html>