docs
      • 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
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Write
        • Owners
        • Signed-in users
        • Everyone
        Owners 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

      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.
      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
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Versions and GitHub Sync Note Insights Sharing URL Help
Menu
Options
Engagement control 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
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners Signed-in users Everyone
Write
Owners
  • Owners
  • Signed-in users
  • Everyone
Owners 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

    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.
    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
    19
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    --- title: HackMD API Book tags: API image: https://hackmd.io/_uploads/SyM7Q06ec.png --- # HackMD API Book ![](https://hackmd.io/_uploads/SyM7Q06ec.png) - [Introduction](https://hackmd.io/@docs/HackMD_API_Book) {%hackmd cuOUX6MaSIKJGm4Fm-ZkCQ %} ## :bell: API Documentation `new` - [HackMD developer-portal](https://hackmd.io/@hackmd-api/developer-portal) :::success : : Share your use case and the API implementation, get a Prime Personal Plan for one month free and get HackMD's special masks. :mega: 只要填寫使用案例,並補上實作文件,我們將贈送一個月免費的 Prime 個人方案 ,以及 HackMD 專屬口罩。 ::: ![](https://hackmd.io/_uploads/SJklzz1fq.png) ## How to contribute use cases / 如何提供使用案例 - [Submit your use case](https://airtable.com/shr2tTAHX5mlrsEbp)[target=_blank] - [填寫表單](https://airtable.com/shrtfmMI7gql6H6BP)[target=_blank] OR just append to this book. - [Collaborate this book](https://hackmd.io/scBc3NrMRTqh0-WUwi0SWw?both)[target=_blank] <!-- ![](https://hackmd.io/_uploads/H1AqvrxcF.png) --> 直接在底下共筆吧!就像這樣 :point_down: {%youtube IoEePZp0DsM %} ## Use Cases / 使用案例 **:point_down: Append new use cases below :point_down: 請往下共筆** - [Update note with GitHub Actions 透過 GitHub Actions 更新筆記內容](/yvPMLKnzSBuPaYpsg-59Rg) `done` - [Create Meeting Minutes automatically 定時自動開新的會議紀錄](/GGui-fMZRuSXb-JfTuhIfw) - [Support LikeCoin 加入Like Coin贊助連結](/@billy3321/BkpTisk5F) - [Embed Spotify in HackMD 從 HackMD 播放 Spotify 上的音樂](https://hackmd.io/DuYwiSSkSe-AWa-aTbCuSg) - [Discord bot with HackMD](https://hackmd.io/@hackmd-api/discord-integration) - [Integrate with VSCode VSCode 整合](/jrdfzHNRQGuMbxilQPaexA) - [Third party write access 第三方寫入](/X2EsCJfTTGGU-r25s2E-vg) - [Browser extension hackbar: kbar component 指令面板](https://hackmd.io/@uier/kbar-component-hackbar) - [Add users via Google APP Scripts 利用 Google App Scripts 增減團隊成員](/ZPvhdqvATsGsEwcpzlnKMg) - [Mapping URLs of notes and their corresponding downloaded contents](/QXSnMEx6RkGDrFxFR0nCCQ) - [Push notes to Github or a remote git repository in batch](/t4HkwKd9Q8SUkSY0VnmxPw) - [Archive or hide notes that are inactive for a while in batch](/cWfkV5ZaSs-CphtVKNDxHQ) - [Camera take picture into HackMD 教室中相機拍照直接進HackMD筆記](https://hackmd.io/@milochen0418/hackmd-camera-api) - Edited on HackMD, would use Beta API to deploy new article to GitHub Page with Hexo - [用API批次修改文章權限(PyHackMD)](/i7dUe9PeRA2o8R9ngrAnaw) - [用API打造LINE Chat Bot](/xS6jtnEFSayEZbctrlJxRQ) - [C#/.net core HackMD.API SDK Open Source Project](https://github.com/isdaviddong/HackMD.API) [target=_blank] [![Build status](https://dev.azure.com/twDevOpsLabs/HackMD.API/_apis/build/status/HackMD.API-ASP.NET%20Core-CI)](https://dev.azure.com/twDevOpsLabs/HackMD.API/_build/latest?definitionId=103) [![package](https://img.shields.io/nuget/v/HackMD.API)](https://www.nuget.org/packages/HackMD.API) - [HackMD extension for Raycast](/@yukai/hackmd-extension-for-raycast) - [Submit homework to HackMD via Google Form with automated check | 使用 Google Form 繳交作業至 HackMD 並自動化檢查](https://hackmd.io/@idoleat/Hky-pQs26) - [Python package for HackMD API]([https](https://)://github.com/eugene87222/python-HackMD) - [Get Note API 使用hackmd api 輕鬆串接hackmd 將文章放到你的網頁上](https://github.com/changjam/getNoteAPI) - [KaLUG.tw 整合Hackmd/astro.js 線上線下並行聚會](/@kalug/online_meetups) - [🚀 從零開始:HackMD CLI 完整教學,輕鬆管理你的筆記](/bj30H-KHSbaL1YMBzY76yQ) - [HackMD Rust API client](https://github.com/EastSun5566/hackmd-api-client-rs) [target=_blank] [![crates.io](https://img.shields.io/crates/v/hackmd-api-client-rs.svg)](https://crates.io/crates/hackmd-api-client-rs) [target=_blank] - [只用 100+ 行扣寫一個超迷你 HackMD Agent](/@EastSun5566/building-a-tiny-hackmd-agent-zh) ## Contact us - [support@hackmd.io](mailto:support@hackmd.io) - [Twitter](https://twitter.com/hackmdio)[target=_blank] - [Facebook](https://www.facebook.com/hackmdio)[target=_blank] :::info This platform is endorsed and maintained by the HackMD Team. Contents are community-driven. 本平台為 HackMD 官方所設,內容為社群協力整理。 ::: :::success This platform is built in [HackMD Book mode <i class="fa fa-book"></i>](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-create-book) 本平台採用 [HackMD 書本模式 <i class="fa fa-book"></i>](https://hackmd.io/c/tutorials-tw/%2Fs%2Fhow-to-create-book-tw) :::

    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

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    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