Skip to content

docs: add HackMD as a CMS guide - #14553

Open
EastSun5566 wants to merge 3 commits into
withastro:mainfrom
EastSun5566:feat/hackmd-cms-guide
Open

EastSun5566 wants to merge 3 commits into
withastro:mainfrom
EastSun5566:feat/hackmd-cms-guide

Conversation

@EastSun5566

Copy link
Copy Markdown

Hi Astro team, thanks for the great docs!

Description (required)

I’m a dev at HackMD, a collaborative Markdown workspace. I’d like to add a guide for using HackMD as a CMS with Astro.

The guide shows how to:

  • Fetch publicly readable notes using the official @hackmd/api client
  • Render Markdown content with markdown-it
  • Generate static pages for HackMD notes

It also adds the HackMD logo and links to astro-hackmd, a minimal example demo.

Validation completed:

  • Prettier
  • ESLint
  • Astro build
  • Link check

Thanks for reviewing!

@astrobot-houston

astrobot-houston commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the tracking.ignoredKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
guides/cms/hackmd.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@astrobot-houston

Copy link
Copy Markdown
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@github-actions

github-actions Bot commented Sep 16, 2026

Copy link
Copy Markdown

Preview deployment

✅ Deployment complete!

@EastSun5566

Copy link
Copy Markdown
Author

@ArmandPhilippot ArmandPhilippot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @EastSun5566, and welcome to the Docs contributors! 🙌🏽

I've left a few suggestions:

  • slightly optimize the logo size.
  • a few notes around asides

But otherwise, this looks almost ready to me! Thank you for making sure to stay close to our writing style!

FYI, we usually expect a stub before you write a full guide, and that's why it makes a bit more time before you get a review. But, I know HackMD is a well-know service, so we can make an exception!
I prefer to state this clearly to avoid any complaints if we end up rejecting a guide from another service...

Comment thread public/logos/hackmd.svg
Comment thread src/content/docs/en/guides/cms/hackmd.mdx
Comment thread src/content/docs/en/guides/cms/hackmd.mdx Outdated
Comment thread src/content/docs/en/guides/cms/hackmd.mdx Outdated
Comment thread src/content/docs/en/guides/cms/hackmd.mdx
Comment thread src/content/docs/en/guides/cms/hackmd.mdx Outdated
Comment thread src/content/docs/en/guides/cms/hackmd.mdx Outdated
@ArmandPhilippot ArmandPhilippot added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. 3rd-party guide Community submitted CMS, deploy, backend etc. guide labels Sep 18, 2026
@EastSun5566

Copy link
Copy Markdown
Author

@ArmandPhilippot Thanks for your detailed review! I’m also sorry that I didn’t read the guide and create a stub page first.

I prefer to state this clearly to avoid any complaints if we end up rejecting a guide from another service...

That’s totally fair. I appreciate you making an exception for us.

I’ve addressed all the feedback and comments. I look forward to the next steps. Thanks again!

Comment thread src/content/docs/en/guides/cms/hackmd.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3rd-party guide Community submitted CMS, deploy, backend etc. guide add new content Document something that is not in docs. May require testing, confirmation, or affect other pages.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants