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 New
    • Engagement control
    • Make a copy
    • 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 Note Insights Versions and GitHub Sync Sharing URL Help
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
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
    4
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # Welcome to your team's workspace Congratulations! :tada: You've created a team workspace, where collaboration and transparency thrive. A team's workspace is the central hub for working together on shared notes, making it easy for everyone to contribute, edit, and stay aligned. Whether you're collaborating on technical design docs or brainstorming ideas, team workspaces allow for open communication and seamless real-time collaboration. This guide will show you how to get the most out of your workspace, helping your team stay productive, organized, and in sync. Let's get started! ## What we'll cover - [Team roles & permissions](#Team-roles-and-permissions) - [Inviting teammates](#Inviting-teammates) - [Collaborating with external invitees](#Collaborating-with-external-invitees) - [Backing up notes](#Backing-up-notes) - [Public vs private teams](#Public-vs-private-teams) - [HackMD Prime team plan](#HackMD-Prime-team-plan) - [Further learning](#Further-learning) ## Team roles and permissions There are a few different ways your teammates can interact with notes within your team workspace. 1. All members have "Read" access to every note 2. Only Writers and Admins have "Write" access 3. Only Admins can delete a team note, manage members, or update billing settings 4. All members are considered "Owners" of workspace notes when configuring note permissions And all team members receive notifications when someone else edits or mentions them in a team note. ## Inviting teammates Now that you understand the basic structure of team roles and permissions, let's start inviting teammates to join the workspace. 1. In the Overview page, click the <i class="fa fa-cog" aria-hidden="true"></i> at the right of "Team space", and click "Team settings" <img src="https://hackmd.io/_uploads/rycnxqUpR.png" width=300 style="display:block;margin:10px auto" /> 2. Once on the "Team Settings" page, switch to the "Members" tab ![圖片](https://hackmd.io/_uploads/ByFiaCnekg.png) 3. Add in the HackMD username or the email address of the member you'd like to join your team workspace - They'll receive an invitation email with instructions on how to join your team 4. Set their role (Reader, Writer, or Admin) and click "Add" ![圖片](https://hackmd.io/_uploads/rJSTaAnlJl.png) And that's it! The more members you invite to your workspace the more you'll get out of your Team Workspace. >[!Note] Upgrade your team to Prime >If you've hit the workspace members limit, you can easily [**upgrade your team to Prime**](https://hackmd.io/c/tutorials/%2F%40docs%2Funlock-team-member-limit?utm_source=prepopulatednote&utm_medium=editor&utm_campaign=teamtutorial&utm_content=tutorial). ## We value your feedback! Did you find this guide helpful? Answer one question in [this survey](https://tally.so/r/3EbOAA) and let us know. ## Collaborating with external invitees You can easily collaborate with individuals outside of your team workspace by adding them to specific notes. Here's how it works: 1. Open the "Share" menu ![image](https://hackmd.io/_uploads/H1_F0YUa0.png =120x) 2. Add their email address to the "Invitee" section at the bottom of the menu 3. Click "Invite" <img src="https://hackmd.io/_uploads/S1vR0KLpA.png" width=350 style="display:block;margin:10px auto" /> And that's it! >[!Caution] Be mindful of confidential information >When you set the reading permission of a note to 'Everyone,' non-team members who have the link will also be able to view the content. [ → Learn more about invitees here](https://hackmd.io/c/tutorials/%2Fs%2Finvite?utm_source=prepopulatednote&utm_medium=editor&utm_campaign=teamtutorial&utm_content=tutorial) ## Backing up notes Backing up your notes is essential for maintaining redundancy and safeguarding important information. Regular backups ensure that your content is preserved. Backing up your notes in HackMD takes just a few clicks. 1. Open the "Team settings" page 2. Navigate to the "Team notes" section 3. Click "Download all notes" <img src="https://hackmd.io/_uploads/rygDBQoFY.png" width=300 style="display:block;margin: 30px auto" /> ## Public vs private teams Within HackMD you can have a public or a private team. As you might have guessed, public teams are great for open-source teams that share knowledge with the public. In fact, there's no limit count to members of a Public Team, furthering the benefits for open source teams. Private teams are ideal for teams looking to keep internal, sensitive data private. And on HackMD, you can switch between the two, so you can adjust as your community grows. [ → Learn more about switching between public and private teams here](https://hackmd.io/@docs/switch-public-private-team?utm_source=prepopulatednote&utm_medium=editor&utm_campaign=teamtutorial&utm_content=tutorial) ## We value your feedback! Did you find this guide helpful? Answer one question in [this survey](https://tally.so/r/3EbOAA) and let us know. ## HackMD Prime team plan HackMD Prime is a powerful upgrade to your team workspace designed to help you scale collaboration within your team and community. With Prime, you gain access to features like full-text search, unlimited team invites, unlimited custom templates, and no limits to the GitHub integration. ### Default permissions Default permission is a Prime-only feature. With this feature, you can rest assured that all notes will follow the same permissioning logic. Here's how it works: 1. Open the "Team Settings" 2. Navigate to the "Team notes" section 3. Scroll down to the "Advanced settings" and set your default permissions 4. Click "Save" <img src="https://hackmd.io/_uploads/Syo3rXoKF.png" width=600 style="display:block;margin: 30px auto" /> ### Changing your subscription Ready to harness the power of HackMD Prime for your team? Here's how to change your subscription: 1. In the workspace sidebar, click the <i class="fa fa-cog" aria-hidden="true"></i> to the right of "Team space" 2. Click "Team billings" <img src="https://hackmd.io/_uploads/rycnxqUpR.png" width=300 style="display:block;margin:10px auto" /> 3. Navigate to the "Change plan" section 4. Click "Change payment method" and fill in the credit card / debit card information. <img src="https://hackmd.io/_uploads/ByUAQcLTR.png" width=600 style="display:block;margin:10px auto" /> ### Payment and invoice There are a few things to note when filling out the payment information. 1. Invoices will be sent to the email address provided when you upgrade. 2. If you need to include a Taiwan Tax ID on your invoice, please select "Taiwan" in the Country field. The Taiwan Tax ID field will appear automatically. ![image](https://hackmd.io/_uploads/H1njL9I6C.png) [ → Learn more about Prime's yearly payment here](https://hackmd.io/@docs/yearly-payment-faq-en?type=view&utm_source=prepopulatednote&utm_medium=editor&utm_campaign=teamtutorial&utm_content=tutorial) ## Further learning Before you go, HackMD has an official user manual with instructions for all its features! In our tutorial book, you'll find detailed guides to all the main features of HackMD that boost your productivity. ### :point_right: [HackMD Tutorial Book](https://hackmd.io/c/tutorials/%2Fs%2Ftutorials?utm_source=prepopulatednote&utm_medium=editor&utm_campaign=teamtutorial&utm_content=tutorial) :point_left: Don't want to miss the latest news and feature updates from HackMD? Be sure to follow our social channels or join us on Discord. - :mailbox: support@hackmd.io - [X (Twitter)](https://x.com/hackmdio) - [Facebook](https://www.facebook.com/hackmdio) - [LinkedIn](https://www.linkedin.com/company/hackmd) - [Discord](https://discord.gg/rAkfPd5Z) ## We value your feedback! Did you find this guide helpful? Answer one question in [this survey](https://tally.so/r/3EbOAA) and let us know.

    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