MichaelHIlliard
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.

      Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Explore these features while you wait
      Complete general settings
      Bookmark and like published notes
      Write a few more notes
      Complete general settings
      Write a few more notes
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Engagement control
    • Make a copy
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Make a copy Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.

    Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Explore these features while you wait
    Complete general settings
    Bookmark and like published notes
    Write a few more notes
    Complete general settings
    Write a few more notes
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # The Collaborative Markdown Workspace for Teams and Developers HackMD is a real-time, collaborative Markdown editor built for teams, developers, researchers, and communities who prefer writing in plain-text Markdown but need modern collaboration features. It combines a lightweight, portable format (Markdown) with real-time editing, publishing and integrations that make it useful for documentation, meeting notes, specs, blogs, and knowledge bases. ## Quick history (the short version) HackMD began as a collaborative Markdown editor and later split into two tracks: the hosted/enterprise product (HackMD) and an open-source community fork. The community fork has been maintained under names such as CodiMD and HedgeDoc — a route many teams choose when they need self-hosting, custom integrations, or stricter control over data. ## Who is HackMD for? * Developer teams who work in Markdown and want a lighter, faster alternative to heavy content platforms. * Research and academic groups collaborating on notes, specs, or papers. * Product and engineering teams writing RFCs, runbooks, or design docs. * Communities and open-source projects that publish collective knowledge publicly. ## Core features (what makes it useful) * Real-time collaborative editing: multiple users can edit the same Markdown document simultaneously, with cursor presence and live updates. * Dual-pane editor + live preview: edit raw Markdown and see the rendered output side-by-side. * Templates & snippets: reusable templates for meeting notes, RFCs, retros, and more to standardize documents. * Publish / share options: publish docs publicly or restrict access, with custom URLs and embed support. * Integrations: push or sync documents with version control providers (GitHub), import/export from Google Drive, Dropbox, and support for gists. * Export formats: export to .md, PDF, or HTML for distribution. * Access controls & teams: workspace and team-level features for organizing documents and permissions. ## Pricing snapshot HackMD offers a free tier for small teams and individuals and paid “Prime” plans for Personal, Team, and Enterprise needs. The paid plans add more seats, collaboration features, and administrative controls. Pricing and exact feature sets change over time, so check their pricing page for the current details. ## Self-hosting: CodiMD / HedgeDoc If you want full control over data or need to install on your own infrastructure, the community fork (commonly referenced as CodiMD or HedgeDoc) is actively maintained and designed for self-hosting. This lets organizations keep documents behind their own firewall, customize authentication (LDAP/SAML/OAuth), and connect to internal storage like S3 for image assets. ## How teams typically use HackMD (practical use cases) * Living documentation: product specs, API docs, runbooks that need lightweight editing and easy exports. * Meeting notes & action items: template-driven notes that are shared and updated live during meetings. * Onboarding & knowledge base: quick searchable docs for new hires with linkable sections and templates. * Conference notes & shared research: real-time collaboration during talks or workshops where many contributors add content. ## Strengths and trade-offs ### Strengths * Fast, frictionless writing in Markdown — ideal for technical audiences. * Real-time collaboration without the visual clutter of heavy WYSIWYG editors. * Portability — content is Markdown-first and easy to version-control or export. ### Trade-offs * Not a full-fledged knowledge platform (e.g., Notion) — lacks advanced databases, dashboards, and some visual content types. * Images and binary attachments may require external storage or special handling when self-hosted. Community discussions note differences in how attachments are stored across hosted vs. self-hosted deployments. ## HackMD vs. alternatives (short comparison) * Notion / Confluence: Better at mixed content (databases, boards, pages). Notion is more visual; HackMD is leaner and better for developer workflows and Markdown portability. * Google Docs: Rich real-time collaboration for generic docs, but Google Docs is not Markdown-native and is less portable for version-controlled workflows. HackMD excels when you want plain text, Git integration, and Markdown exports. * HedgeDoc / CodiMD (self-hosted): If you need to keep everything on your servers, the community project offers parity with many core features of hosted HackMD. ## Practical tips for getting the most from HackMD * Create templates: standardize meeting notes, RFCs, and onboarding docs so contributors know where to add status, decisions, and action items. * Use headings & anchors: organize long docs with H2/H3 headings and internal links for easier navigation. * Link to Git: for change-heavy specs, push versions to a GitHub repo to keep a permanent history. * Set permissions early: decide which docs are public vs. team-only to avoid accidental exposure. * Export regularly: keep a local .md or PDF backup if the doc will be used long-term outside HackMD. ## When to choose HackMD Pick HackMD when your team: * prefers Markdown and plain-text workflows; * needs fast, distraction-free collaboration for technical content; * wants the option to publish public docs while retaining Git-friendly exports; or * requires an easy path to self-hosting via CodiMD/HedgeDoc for privacy or compliance reasons. Even if you’re a [**web app development company**](https://www.appverticals.com/web-application-development), HackMD can be especially valuable for drafting and sharing specifications, documenting APIs, and aligning cross-functional teams before code hits production. It bridges the gap between lightweight text-based documentation and collaborative knowledge sharing. ## Conclusion HackMD sits in a useful niche: the intersection of Markdown portability and real-time collaboration. It’s especially popular among engineers, open-source projects, and teams that value plain text and version control. If your documentation process benefits from short, focused documents that are easy to edit, export, and integrate with developer tooling, HackMD is worth evaluating — and if you need total control over data, the community self-hosted fork is ready to deploy.

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password
    or
    Sign in via Facebook Sign in via X(Twitter) Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    By signing in, you agree to our terms of service.

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully