# Table of Contents
- [Espresso on Bitcoin - HackMD](#espresso-on-bitcoin-hackmd)
- [Forgot password - HackMD](#forgot-password-hackmd)
- [Terms of Service - HackMD](#terms-of-service-hackmd)
- [Sign in to GitHub · GitHub](#sign-in-to-github-github)
- [HackMD: Your Collaborative Markdown Workspace for Knowledge Sharing](#hackmd-your-collaborative-markdown-workspace-for-knowledge-sharing)
- [Forgot your password? · GitHub](#forgot-your-password-github)
- [GitHub · Build and ship software on a single, collaborative platform · GitHub](#github-build-and-ship-software-on-a-single-collaborative-platform-github)
- [403 Forbidden](#403-forbidden)
- [Sign up to GitHub · GitHub](#sign-up-to-github-github)
- [Error](#error)
- [X / Authorize an application](#x-authorize-an-application)
- [HackMD Pricing & Plans: Free, Personal, Team, & Enterprise](#hackmd-pricing-plans-free-personal-team-enterprise)
- [HackMD for Teams & Businesses](#hackmd-for-teams-businesses)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [About HackMD: Our Platform, Mission, & Team](#about-hackmd-our-platform-mission-team)
- [HackMD: Your Collaborative Markdown Workspace for Knowledge Sharing](#hackmd-your-collaborative-markdown-workspace-for-knowledge-sharing)
- [The HackMD Blog: Home](#the-hackmd-blog-home)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [Sign in to GitHub · GitHub](#sign-in-to-github-github)
- [Sign in to GitHub · GitHub](#sign-in-to-github-github)
- [Error](#error)
- [HackMD Tutorial Book - HackMD](#hackmd-tutorial-book-hackmd)
- [403 Forbidden](#403-forbidden)
- [Error](#error)
- [403 Forbidden](#403-forbidden)
- [GitHub General Privacy Statement - GitHub Docs](#github-general-privacy-statement-github-docs)
- [GitHub Terms of Service - GitHub Docs](#github-terms-of-service-github-docs)
- [GitHub Actions · GitHub](#github-actions-github)
- [GitHub Code Review · GitHub](#github-code-review-github)
- [GitHub Issues · Project planning for developers · GitHub](#github-issues-project-planning-for-developers-github)
- [GitHub Codespaces · GitHub](#github-codespaces-github)
- [GitHub Code Search · GitHub](#github-code-search-github)
- [GitHub Copilot · Your AI pair programmer · GitHub](#github-copilot-your-ai-pair-programmer-github)
- [GitHub Security · GitHub](#github-security-github)
- [GitHub Discussions · Developer Collaboration & Communication Tool · GitHub](#github-discussions-developer-collaboration-communication-tool-github)
- [GitHub for teams · Build like the best teams on the planet · GitHub](#github-for-teams-build-like-the-best-teams-on-the-planet-github)
- [Features - HackMD](#features-hackmd)
- [Privacy - HackMD](#privacy-hackmd)
---
# Espresso on Bitcoin - HackMD
\# Espresso on Bitcoin \*Disclaimer(s): This blog is purely conceptual. There are currently no “trust-minimized” validating bridges for rollups on Bitcoin. Everything is currently a multi-sig. There are no Bitcoin rollups in production. There are some cool rollup designs happening around BitVM (e.g. Citrea).\* --- Espresso offers a shared sequencing marketplace for rollups (and other offchain scaling protocols). It enables proposers to bid on slots for individual rollups, or multiple rollups at once. These proposers can be proposers for the Ethereum EVM mainnet, or proposers only participating in HotShot. A new wave of scaling protocols on top of Bitcoin are currently being developed. A number of these proposed protocols are sovereign rollups, or BitVM rollups, that will use Bitcoin for data availability. Bitcoin sidechains are also being developed to act as a settlement layer for rollup-style blockchains. Rollups on top of Bitcoin (or Bitcoin sidechains) can use Espresso to decentralize their sequencer set. Rollup stacks can also opt-in to using Tiramisu DA to offer high throughput and low cost data availability to support validium-like appchains. In this blog post I will cover what it takes for Bitcoin rollups to integrate with Espresso. Espresso is made of two components: a) HotShot finality gadget and b) a combinatorial auction to assign proposers. You can read more on these components \[here\](https://hackmd.io/@EspressoSystems/BasedEspresso#Construction-details). ## Transaction lifecycle In many proposed Bitcoin rollup implementations, \[transactions\](https://www.blog.citrea.xyz/life-cycle-of-a-citrea-transaction/) are sent to a sequencer node for transaction inclusion and ordering. After transactions are included in blocks, and are ordered, blocks are sent to a prover that executes the transactions in the block and submits a valid proof of execution (a.k.a validity proof) to the Bitcoin L1 as an inscription. A \[BitVM\](https://bitvm.org/bitvm2) bridge program, or group of sovereign rollup nodes, will read this proof and verify that the rollup state transition is valid. For rollups settling on sidechains, the transaction life is practically the same as a rollup on Ethereum. This is because proposed Bitcoin sidechains have more expressive execution environments and can (maybe) verify zk-SNARKs containing rollup state transitions. We wrote about that lifecycle \[here\](https://hackmd.io/@EspressoSystems/EspressoSequencer#A-Rollups-Overview). In either of these designs, integrating with Espresso would see the sequencer node be replaced by a marketplace of participating proposers. These proposers can be HotShot proposers or Ethereum L1 proposers who have opted into participation in HotShot consensus. The process is as follows: - Proposers purchase “lottery tickets” to bid on specific rollup slots. Proposers can bid on a single namespace (one rollup) or multiple namespaces (multiple rollups) at once. - Upon winning the rights to build a HotShot block, proposers construct the HotShot block in its given slot. - The block is constructed and broadcasted to a quorum of HotShot nodes who attest to the block commitment and finalize it on HotShot. - This gives rollup users a preconfirmation that their transaction is included in a HotShot block, and will be finalized on its respective L1. After the block is constructed, the block will be sent to a prover who will execute the transactions in the given order and then generate the aforementioned proof of correct execution. It’s worth noting that Espresso’s finality gadget, HotShot, is optimistically responsive and has no fixed block time or size. This means that it can process pretty big blocks in mere seconds under optimistic network conditions. ## Data availability bridge Espresso’s data availability layer, Tiramisu, satisfies the data availability requirement for HotShot. To track the current state of HotShot, and ensure that previously proposed blocks match the proof of execution generated by the prover, a Bitcoin rollup would need to be able to read the current state of Espresso. Due to limitations in Bitcoin script, it is not possible to create a data availability bridge between Tiramisu and an on-chain Bitcoin L1 contract. However, BitVM enables us to run a sidechain bridge program off the Bitcoin mainchain to execute an Espresso light client optimistically, with a 1-N trust assumption. Bridge operators could be challenged by any of the online verifiers in the event that they are withholding data or are offline. Thus, we can have a subset of Bitcoin full \[nodes\](https://github.com/BitVM/bitvm-js/blob/main/docs/sidechain\_bridges.md) participate in the DA bridge between Espresso and BitVM. In this design, the BitVM bridge program would run an Espresso light client and verify Espresso signatures to read Espresso headers directly. Once the Bridge is able to read Espresso headers, or the rollup state root, they can implement a dehashing oracle to read whatever they like from Espresso, including reading blobs from Tiramisu DA. This would enable the bridge program to read data blobs directly from Tiramisu and verify them against rollups’ proofs of execution that are inscribed into the Bitcoin L1. This design is suitable for Bitcoin as the bridge program would also be responsible for \[verifying zk-SNARKs\](https://bitvm.org/snark) containing the rollup’s state transitions. Bitcoin sidechains can be more permissive than the Bitcoin L1. A sidechain with more permissive smart contracting capabilities could simply have a bridge program on-chain run an Espresso light client to verify HotShot state. This would enable it to read Espresso headers, and verify rollups’ proof of execution stored against data blobs from Tiramisu. For example, \[SIDE Chain\](https://docs.side.one/) is going to use Espresso to decentralize its sequencer operators for rollups using it as a settlement layer, and could implement this type of bridge program to integrate with Espresso. ## Potential use cases Not only does the Espresso marketplace enable rollups to sell their slots to a network of participating proposers, improving decentralization and credible neutrality, but it also allows for transaction bundles between rollups using Espresso. For example, a rollup using Bitcoin for data availability, and an Ethereum rollup, could sell their slots to a shared proposer, enabling atomic inclusion for rollup transactions between the two rollups (see open questions). This would improve interoperability between Bitcoin rollups and rollups from other ecosystems. Another interesting use case for rollup-like blockchains, on Bitcoin, is using Espresso’s Tiramisu as a data availability layer. This could make these Bitcoin chains pseudo-validiums. This gets especially interesting when chains do not want to enshrine a specific data availability layer, and want to have bridges with multiple blockchains. For example, a validium could have a native bridge contract with Ethereum, and run a BitVM bridge program to secure its Bitcoin assets, and use Espresso for DA. For a modular settlement layer, like Side Protocol, a shared sequencing marketplace will enable its rollups to have improved interoperability and atomicity with each other, and likewise with rollups in other ecosystems. ## MEV Mitigation Espresso enables rollups to enact their own block builder policy for MEV mitigation purposes. For example, rollups could create a builder protocol that leverages an encrypted mempool that doesn’t let block builders see the contents of rollup transactions. Then, proposers who won the right to the rollup’s slot will take the produced block from the builder network, propose its contents to HotShot attesters, and see the block be finalized on HotShot (see open questions). For more on MEV mitigation and Espresso, please see this post on \[Timeboost\](https://medium.com/offchainlabs/time-boost-a-new-transaction-ordering-policy-for-arbitrum-5b3066382d62) and this blog \[post\](https://blog.shutter.network/shutter-for-espresso/) from Shutter Network. ## Open questions When writing this blog, some team members and I chatted through some open questions we have on such an integration: - In the future could Espresso add a Bitcoin signature into Espresso state? If so, then presumably the Bitcoin L1 could actually verify Tiramisu. Is this possible given current constraints on Bitcoin L1? If not, what would be needed to make it possible? - Can a rollup on Bitcoin synchronize its slots with the Ethereum L1 to ensure stronger atomicity guarantees with Ethereum rollups? - For what it’s worth, some of us think so! - Is it possible to split the "Bitcoin L1 state" into smaller parts? This is desirable because, instead of being conditional on a Bitcoin block, rollup finality is conditional on an individual UTXO. So long as that UTXO doesn't change due to a reorg, then x-rollup atomicity is unaffected, even if Bitcoin reorgs as a whole. - What would be needed for Bitcoin miners to participate as HotShot proposers? - What is the relationship with rollup block builders, HotShot proposers and Bitcoin miners in the context of Bitcoin? For example, what are the consequences of a rollup that implements a specific builder policy (e.g. Timeboost) in a world where Bitcoin miners can also act as HotShot proposers? ## To Finish While Espresso is primarily focused on supporting Ethereum’s rollup-centric roadmap, the introduction of more expressive bridge programs creates an opportunity for potential integrations between Bitcoin rollups and Espresso. Espresso will likely be in production before Bitcoin rollups, so this also gives them an interesting opportunity to launch with decentralized sequencers and have improved composability with all rollups integrated with Espresso. If you are interested in exploring integrations between Bitcoin and Espresso, please contact me on \[Twitter\](https://twitter.com/januszg\_) at @januszg\_. ### References 1. \[BitVM Sidechain Bridges\](https://github.com/BitVM/bitvm-js/blob/main/docs/sidechain\_bridges.md) 2. \[Chainway Clementine Blog\](https://www.blog.citrea.xyz/unveiling-clementine/)
---
# Forgot password - HackMD
### Forgot password
Enter your email address and we will send you a link to reset password
Email
---
# Terms of Service - HackMD
Terms of Service === By approving these Terms of Service ("Terms of Service") or, alternatively, by (i) using the HackMD website, (ii) using any HackMD tool, service, or platform, including but not limited to, HackMD-it browser extension, HackMD VSCode extension, and HackMD Hub GitHub App, or (iii) subscribing to any HackMD free or paid subscriptions or plans, the customer ("Customer" or "You") agree to be bound by the Terms of Service of HackMD, Inc. ("HackMD" or "We") set forth herein. If the Customer enters into this Terms of Service on behalf of a company or other legal entity, it represents that it has the authority to bind such entity and all users who access the HackMD Service through the Customer's account ("Users"). If the Customer does not have such authority, or if it does not agree with the Terms of Service, it must not accept this Terms of Service and shall not use the HackMD Service. \[Privacy Policy\](/s/privacy) – How we maintain and protect your personal information in HackMD. Although we may attempt to notify you via email when major changes are made, you should visit this page periodically to review the terms. HackMD may, in its sole discretion, modify or revise these terms and conditions, Terms of Service, and policies at any time, with or without the notice, and you agree to be bound by such modifications or revisions. If you do not accept and abide by this Agreement, you shall not use HackMD Service. Nothing in this Terms of Service shall be deemed to confer any third party rights or benefits. 1. Description of Service. HackMD serves as a real-time collaborative workplace environment, including but not limited to, HackMD website, HackMD browser extensions, HackMD desktop clients, HackMD VSCode extension, HackMD Hub GitHub app, HackMD collaborative platform, and any feature or service provided by HackMD under the free or paid subscriptions or plans (each, a "Service"). You understand and agree that the Service is provided on an AS IS and AS AVAILABLE basis. HackMD disclaims all responsibility and liability for the availability, timeliness, security or reliability of the Service. HackMD also reserves the right to modify, suspend or discontinue the Service with or without notice at any time and without any liability to you. Further limitations of liability and responsibility are detailed in Section 10 and 20 of this Terms of Service. 2. Third Party Product or Service. Our Service may integrate with third party applications or software that complement Customer's use of the Service (each, a "Third Party Product"), including but not limited to, internet browsers, GitHub development platform, payment service providers, data analytic applications, and third-party computing and storage providers. You may refer to HackMD's Private Policy for Third Party Product List in detail. THESE ARE NOT OUR SERVICES, SO WE DO NOT WARRANT OR SUPPORT THESE THIRD PARTY PRODUCTS. You acknowledge and agree that HackMD shall not be responsible or liable, directly or indirectly, for any damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods or services available on or through any such Third Party Products. We strongly advise you to read the terms and conditions and privacy policies of any Third Party Products that you interact with. If a Third Party Product is integrated for Customer's use of our Service, please be mindful of certain Customer's data that will be shared with the third party provider and the purposes for which the provider requires access. You may check our Private Policy for data sharing detail. We will not be responsible for any use, disclosure, modification or deletion of Customer's data that is transmitted to, or accessed by, a Third Party Product. 3. Use of Service. You must comply with the Terms of Service and ensure that all users under your account comply with the Terms of Service. We may review conduct for compliance purposes, but we have no obligation to do so. We aren't responsible for the content of any Customer's data or the way Customer or its account users choose to use the Services to store or process any Customer's data. The Services are not intended for and should not be used by anyone under the age of 13. You must ensure that all your account users are over 13 years old. Customer is solely responsible for providing high speed internet service for itself to access and use the Services. Customer must provide current, accurate identification, contact, and other information that may be required as part of the registration process and/or continued use of the Service. Customer is responsible for maintaining the confidentiality of Customer's Service password and account, and is responsible for all activities that occur thereunder. 4. Proper Use. You agree that you are responsible for your own communications and for any consequences thereof. Your use of the Service is subject to your acceptance of and compliance with the agreement, order form ("Order Form"), the Terms of Service, or such other URL or policies as HackMD may provide from time to time. You agree that you will use the Service in compliance with all applicable local, state, national, and international laws, rules and regulations, including any laws regarding the transmission of technical data exported from your country of residence. You shall not, shall not agree to, and shall not authorize or encourage any third party to: (i) use the Service to upload, transmit or otherwise distribute any content that is unlawful, defamatory, harassing, abusive, fraudulent, obscene, contains viruses, or is otherwise objectionable as reasonably determined by HackMD; (ii) upload, transmit or otherwise distribute content that infringes upon another party's intellectual property rights or other proprietary, contractual or fiduciary rights or obligations; (iii) prevent others from using the Service; or (iv) use the Service for any fraudulent or inappropriate purpose. Violation of any of the foregoing may result in immediate termination of the use of Service and the Terms of Service, and may subject you to penalties and other legal consequences. HackMD reserves the right, but shall have no obligation, to investigate your use of the Service in order to determine whether a violation of the Terms of Service has occurred or to comply with any applicable law, regulation, legal process or governmental request. HackMD reserves the right to refuse service to anyone at any time without notice for any reason. 5. Content of the Service. Any content, including but not limited to any opinions, comments, standpoints, or political views expressed in your account do not represent the views of HackMD. You alone are responsible for your content. You assume all risks associated with your content, including anyone's reliance on its quality, accuracy, or reliability, and any risk associated with information you disclose. You represent that you own or have the necessary permissions to use and authorize the use of your content as described herein. You shall not imply that your content is in any way sponsored or endorsed by HackMD. HackMD takes no responsibility for your or any third party content (including, without limitation, any viruses or other disabling features), nor does HackMD have any obligation to monitor such your or third party content. HackMD reserves the right at all times to remove or refuse to distribute any content on the Service, such as content which violates the Terms of Service. HackMD also reserves the right to access, read, preserve, and disclose any information as it reasonably believes is necessary to (a) satisfy any applicable law, regulation, legal process or governmental request, (e.g. the Digital Millennium Copyright Act or General Data Protection Regulation compliance) (b) enforce this Terms of Service, including investigation of potential violations hereof, \\(c\\) detect, prevent, or otherwise address fraud, security or technical issues, (d) respond to user support requests, or (e) protect the rights, property or safety of HackMD, its users and the public. HackMD will not be responsible or liable for the exercise or non-exercise of its rights under this Terms of Service. 6. Security. The protection of Customer's data is a top priority for us so we will maintain administrative, physical, and technical safeguards with commercially reasonable effort. Those safeguards will include measures for preventing unauthorized access, use, modification, deletion and disclosure of Customer's data by our personnel or third party service provider. Before sharing Customer's data with any of our third party service providers, we will ensure that the third party maintains, at a minimum, reasonable data practices for maintaining the confidentiality and security of Customer data and preventing unauthorized access. Customer (not us) bears sole responsibility for adequate security, protection and backup of Customer's data when in Customer's or its representatives' or agents' possession or control. We are not responsible for what Customer and its account users, third party service provider, or Third Party Products do with Customer's data. That is your responsibility. 7. Your Intellectual Property Rights. HackMD does not claim any ownership in any of the content that you create, upload, transmit or store in your HackMD account. Unless otherwise expressly agreed by both parties in a separate terms and conditions, Customer (for itself and all of its account users) grants us a worldwide, non-exclusive, limited term license to access, use, process, copy, distribute, perform, export and display Customer's content , and any Third Party Products created by or for Customer, only as reasonably necessary (a) to provide, maintain and update the Services; (b) to prevent or address service, security, support or technical issues; or \\(c\\) as required by law or as permitted by any policy published by HackMD. Customer represents and warrants that it has secured all rights in and to Customer's data from its Users as may be necessary to grant this license. 8. Copyright. We respect the intellectual property rights of others. It is our policy to respond to any claim that content posted on the Service infringes on the copyright or other intellectual property rights ("Infringement") of any person or entity. It is our policy, in appropriate circumstances and at our discretion, to disable or terminate the accounts of users who repeatedly Infringe copyrights or intellectual property rights of others. If you are a copyright owner, or authorized on behalf of one, and you believe that any content, materials or works uploaded, downloaded or appearing on the Service have been copied in a way that constitutes copyright infringement, you may submit a notification pursuant to the Digital Millennium Copyright Act (DMCA) by providing us with the following information in writing (see 17 U.S.C 512\\(c\\)(3) for further detail): (i) an electronic or physical signature of the person authorized to act on behalf of the owner of the copyright's interest; (ii) a description of the copyrighted work that you claim has been infringed; (iii) identification of the allegedly infringing material on the Service, including URL or other specific location on the Service where the material that you claim is infringing is located; (iv) your address, telephone number, and email address; (v) a statement by you that you have a good faith belief that the disputed use is not authorized by the copyright owner, its agent, or the law; (vi) a statement by you, made under penalty of perjury, that the above information in your notice is accurate and that you are the copyright owner or authorized to act on the copyright owner's behalf. Such notices of copyright infringement should be sent via email to support@hackmd.io. 9. Intellectual Property Rights. HackMD's Intellectual Property Rights. You acknowledge and agree that HackMD owns all right, title and interest in and to the Service, including without limitation any and all intellectual property rights (the "HackMD Rights"), and such HackMD Rights are protected by international intellectual property laws. Accordingly, you agree that you will not copy, reproduce, alter, modify, or create derivative works from the Service. You also agree that you will not use any robot, spider, crawler, other automated device, or manual process to monitor or copy any content from the Service. The HackMD Rights include rights to (i) the Service developed and provided by HackMD; and (ii) all software, website, interface, and source codes associated with the Service. 10. Representations and Warranties. You represent and warrant that (a) all of the information provided by you to HackMD to participate in the Services is correct and current; and (b) you have all necessary right, power and authority to enter into this Terms of Service and to perform the acts required of you hereunder. You further represent and warrant that you are responsible for the conduct of your account users and their compliance with the terms of this Terms of Service and all Policies published by HackMD from time to time. EXCEPT AS EXPRESSLY PROVIDED FOR HEREIN, THE SERVICE AND ALL RELATED COMPONENTS AND INFORMATION PROVIDED BY HACKMD ARE PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS WITHOUT ANY WARRANTIES OF ANY KIND, AND WE EXPRESSLY DISCLAIM ANY AND ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. CUSTOMER ACKNOWLEDGES AND AGREES THAT WE DO NOT WARRANT THAT THE SERVICE WILL BE UNINTERRUPTED, TIMELY, SECURE, OR ERROR-FREE. 11. Privacy. As a condition to using the Service, you agree to the terms of the HackMD Privacy Policy as it may be updated from time to time. HackMD understands that privacy is important to you. You do, however, agree that HackMD may monitor, edit or disclose your personal information, if required to do so in order to comply with any valid legal process or governmental request (such as a search warrant, subpoena, statute, or court order), or as otherwise provided in the Terms of Service and the HackMD Privacy Policy. 12. Service Term. Unless specified at the Service interface "check-out" and in the Order Form(s), a free plan continues until terminated, while a paid subscription has a term that may expire or be terminated. The Service remains effective until all subscriptions ordered under the Service Term have expired or been terminated under the Terms of Service. Termination of the Service will terminate all subscriptions, plans and all Order Forms. 13. Auto-Renewal. Unless specified at the Service interface "check-out" and in the Order Form(s), (a) all paid subscriptions or plans automatically renew (without the need to go through the Services interface "check-out" or execute a renewal Order Form) for additional periods equal to one (1) year or the preceding term, whichever is shorter; and (b) unless notified by HackMD at least thirty (30) days before the end of a subscription term, the per-unit pricing during any automatic renewal term will remain the same as it was during the immediately prior term. 14. Account Inactivity. For all free subscriptions or plans, after a period of inactivity, whereby a user fails to login to an account for a period of six months, HackMD reserves the right to disable or terminate the account and Service. If an account has been deactivated for inactivity, the username and URLs associated with that account may be given to another user without notice to you or such other party. 15. Termination for Cause. We or Customer may terminate the Service on notice to the other party if the other party materially breaches the Terms of Service , Order Forms, or any Policy published by HackMD (e.g. Customer fails to pay in time). Customer is responsible for its account users, including for any breaches of this Terms of Service caused by its account users. We may terminate the Service immediately on notice to Customer if we reasonably believe that the Services are being used by Customer or its account users in violation of applicable law. Upon any termination for cause by HackMD, Customer will pay any unpaid fees covering the remainder of the term of those subscriptions after the effective date of termination. In no event will any termination relieve Customer of the obligation to pay any fees payable to us for the period prior to the effective date of termination. Upon any termination for cause by Customer, we will refund Customer any prepaid fees, if any, covering the remainder of the term of all paid subscriptions after the effective date of termination. 16. Termination without Cause (Free Plan). Customer may terminate its free subscriptions or plans by providing notice to HackMD at support@hackmd.io without cause; provided, however, that a terminated account may continue to exist for up to 60 business days before such termination takes effect. We may at any time and for any reason terminate Customer's free plan or subscription, or suspend or terminate Customer's free account. 17. Termination without Cause (Paid Subscription). Paid Subscription is non-cancelable without cause. During the term of Service set forth in the Order Form(s), Customer may not terminate its paid subscriptions or plans unless otherwise agreed and approved by HackMD in advance. 18. Payment Obligations. For Customer that purchases our Service under the paid subscription plans, fees are specified at the Service interface "check-out" and in the Order Form(s) — and must be paid in advance. Payment obligations are non-cancelable and, except as expressly stated by HackMD, fees paid are non-refundable. For clarity, in the event Customer downgrades any subscriptions from a paid plan to a free plan, Customer will remain responsible for any unpaid fees under the paid plan, and Services under the paid plan will be deemed fully performed and delivered upon expiration of the initial paid plan subscription term. Please contact HackMD for more information about payment options. In the event we agree to invoice Customer by email, full payment must be received within thirty (30) days from the invoice date. Fees are stated exclusive of any taxes, levies, duties, or similar governmental assessments of any nature, including, for example, value-added, sales, use or withholding taxes, assessable by any jurisdiction (collectively, "Taxes"). Customer will be responsible for paying all Taxes associated with its purchases, except for those taxes based on our net income. Should any payment for the Services be subject to withholding tax by any government, Customer will reimburse us for such withholding tax. 19. Termination Process. In the event of termination, your account will be disabled and you may not be granted access to your account or any files or other content contained in your account although residual copies of information may remain in our system. Except as set forth above or unless HackMD has previously canceled or terminated your use of the Services (in which case subsequent notice by HackMD shall not be required), HackMD will notify you via email of any such termination or cancellation, which shall be effective immediately upon HackMD's delivery of such notice. Sections 2-11, and 18 – 30 of the Terms of Service shall survive expiration or termination. 20. Limitation of Liability. OTHER THAN IN CONNECTION WITH A PARTY'S INDEMNIFICATION OBLIGATIONS HEREUNDER, IN NO EVENT WILL EITHER CUSTOMER'S OR HACKMD'S AGGREGATE LIABILITY ARISING OUT OF OR RELATED TO THE SERVICE OR THE TERMS OF SERVICE (WHETHER IN CONTRACT OR TORT OR UNDER ANY OTHER THEORY OF LIABILITY) EXCEED THE TOTAL AMOUNT PAID BY CUSTOMER HEREUNDER IN THE TWELVE (12) MONTHS PRECEDING THE LAST EVENT GIVING RISE TO LIABILITY. THE FOREGOING WILL NOT LIMIT CUSTOMER'S PAYMENT OBLIGATIONS UNDER THE "PAYMENT OBLIGATION" SECTION ABOVE. IN NO EVENT WILL EITHER CUSTOMER OR ANY MEMBER OF HACKMD HAVE ANY LIABILITY TO THE OTHER PARTY OR TO ANY THIRD PARTY FOR ANY LOST PROFITS OR REVENUES OR FOR ANY INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, COVER OR PUNITIVE DAMAGES HOWEVER CAUSED, WHETHER IN CONTRACT, TORT OR UNDER ANY OTHER THEORY OF LIABILITY, AND WHETHER OR NOT THE PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE FOREGOING DISCLAIMER WILL NOT APPLY TO THE EXTENT PROHIBITED BY APPLICABLE LAW. Customer is responsible for all login credentials, including usernames and passwords, for administrator accounts as well the accounts of its users. HackMD will not be responsible for any damages, losses or liability to Customer, its account users, or anyone else, if such information is not kept confidential by Customer or its account users, or if such information is correctly provided by an unauthorized third party logging into and accessing the Services. The limitations under this "Limitation of Liability" section apply with respect to all legal theories, whether in contract, tort or otherwise, and to the extent permitted by law. The provisions of this "Limitation of Liability" section allocate the risks under this Terms of Service between the parties, and the parties have relied on these limitations in determining whether to enter into the Service and the pricing for the Services. 21. Indemnification. Customer will defend HackMD and any members of HackMD (collectively, the "Indemnified Parties") from and against any and all third party claims, actions, suits, proceedings, and demands arising from or related to Customer's or any of its account users' use of the Service, or Customer's or any of its account users' violation of the Terms of Service (a "Claim Against Us"), and will indemnify the Indemnified Parties for all reasonable attorney's fees incurred and damages and other costs finally awarded against a Indemnified Party in connection with or as a result of, and for amounts paid by a Indemnified Party under a settlement Customer approves of in connection with, a Claim Against Us. We will provide Customer with prompt written notice of any Claim Against Us and allow Customer the right to assume the exclusive defense and control, and cooperate with any reasonable requests assisting Customer's defense and settlement of such matter. 22. Confidentiality. Each party ("Disclosing Party") may disclose "Confidential Information" to the other party ("Receiving Party") in connection with the Contract, which is anything that reasonably should be understood to be confidential given the nature of the information and the circumstances of disclosure including all Order Forms, as well as non-public business, product, technology and marketing information. Confidential Information of Customer includes Customer's data stored in HackMD. If something is labeled "Confidential," that's a clear indicator to the Receiving Party that the material is confidential. Notwithstanding the above, Confidential Information does not include information that (a) is or becomes generally available to the public without breach of any obligation owed to the Disclosing Party; (b) was known to the Receiving Party prior to its disclosure by the Disclosing Party without breach of any obligation owed to the Disclosing Party; \\(c\\) is received from a third party without breach of any obligation owed to the Disclosing Party; (d) was independently developed by the Receiving Party; or (e) is required by law. The Receiving Party will (a) take at least reasonable measures to prevent the unauthorized disclosure or use of Confidential Information, and limit access to those employees, affiliates and contractors who need to know such information in connection with the Terms of Service; and (b) not use or disclose any Confidential Information of the Disclosing Party for any purpose outside the scope of this Terms of Service. Nothing above will prevent either party from sharing Confidential Information with financial and legal advisors; provided, however, that the advisors are bound to confidentiality obligations at least as restrictive as those in the Terms of Service. 23. Publicity. Customer grants us the right to use Customer's company name and logo as a reference for marketing or promotional purposes on our website and in other public or private communications with our existing or potential customers, subject to Customer's standard trademark usage guidelines as may provide to us from time-to-time. We don't want to list customers who don't want to be listed, so Customer may send us an email to support@hackmd.io stating that it does not wish to be used as a reference. 24. Force Majeure. Neither us nor Customer will be liable by reason of any failure or delay in the performance of its obligations on account of events beyond the reasonable control of a party, which may include denial-of-service attacks, a failure by a third party hosting provider or utility provider, strikes, shortages, riots, fires, acts of God, war, terrorism, and governmental action. 25. No Third Party Beneficiaries. The parties are independent contractors. The Terms of Service does not create a partnership, franchise, joint venture, agency, fiduciary, or employment relationship between the parties. There are no third party beneficiaries to the Service and Term of Service. 26. Notice. Except as otherwise set forth herein, all notices under the Terms of Service will be by email, although we may instead choose to provide notice to Customer through the Service platform. Notices will be deemed to have been duly given (a) the day after it is sent to Customer, in the case of notices through email; and (b) the same day, in the case of notices through the Service platform. 27. Waiver. No failure or delay by either party in exercising any right under the Terms of Service will constitute a waiver of that right. No waiver under the Terms of Service will be effective unless made in writing and signed by an authorized representative of the party being deemed to have granted the waiver. 28. Severability. The Terms of Service will be enforced to the fullest extent permitted under applicable law. If any provision of the Terms of Service is held by a court of competent jurisdiction to be contrary to law, the provision will be modified by the court and interpreted so as best to accomplish the objectives of the original provision to the fullest extent permitted by law, and the remaining provisions of the Terms of Service will remain in effect. 29. Assignment. Neither party may assign or delegate any of its rights or obligations hereunder, whether by operation of law or otherwise, without the prior written consent of the other party (not to be unreasonably withheld). Notwithstanding the foregoing, either party may assign the Terms of Service in its entirety (including all Order Forms), without consent of the other party, to a corporate affiliate or in connection with a merger, acquisition, corporate reorganization, or sale of all or substantially all of its assets. Customer will keep its billing and contact information current at all times by notifying HackMD of any changes. Any purported assignment in violation of this section is void. A party's sole remedy for any purported assignment by the other party in breach of this section will be, at the non-assigning party's election, termination of the Service and this Terms of Service upon written notice to the assigning party. Subject to the foregoing, the Terms of Service will bind and inure to the benefit of the parties, their respective successors and permitted assigns. 30. Choice of Law; Jurisdiction. The Terms of Service are governed by and construed in accordance with the laws of State of Delaware, United States, without regard to choice or conflicts of law principles. The Terms of Service will specifically not be governed by the United Nations Conventions on Contracts for the International Sale of Goods, if otherwise applicable. The courts located in New Castle, Delaware will have exclusive jurisdiction to adjudicate any dispute arising out of or relating to Service and Terms of Service or its formation, interpretation or enforcement. Each party hereby consents and submits to the exclusive jurisdiction of such courts. In any action or proceeding to enforce rights under the Terms of Service, the prevailing party will be entitled to recover its reasonable costs and attorney's fees. 31. Entire Agreement. The Terms of Service, including these Customer Terms and all referenced webpages and Order Forms, if applicable, constitutes the entire agreement between the parties and supersedes all prior and contemporaneous agreements, proposals or representations, written or oral, concerning its subject matter. Without limiting the foregoing, the Terms of Service supersedes the terms of any online agreement electronically accepted by Customer or any Customer's users. However, to the extent of any conflict or inconsistency between the provisions in the Terms of Service and any other documents or pages referenced in these Customer Terms, the following order of precedence will apply: (1) the Terms of Service, (2) the terms of any Order Form (if any), (3) the portions of the Customer-Specific Supplement that apply to Customer (if any), and (4) finally any other documents or pages referenced in the Terms of Service and agreed by HackMD and Customer. Notwithstanding any language to the contrary therein, no terms or conditions stated in a Customer purchase order, vendor onboarding process or web portal, or any other Customer order documentation (excluding Order Forms) will be incorporated into or form any part of the Terms of Service, and all such terms or conditions will be null and void. Effective: October 15, 2019.
---
# Sign in to GitHub · GitHub
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Sign in to **GitHub**
to continue to **HackMD**
Username or email address
Password [Forgot password?](/password_reset)
Password login alternatives
---------------------------
Sign in with a passkey
New to GitHub? [Create an account](/join?return_to=%2Flogin%2Foauth%2Fauthorize%3Fclient_id%3Df47f304f25add575a164%26redirect_uri%3Dhttps%253A%252F%252Fhackmd.io%252Fauth%252Fgithub%252Fcallback%26response_type%3Dcode%26state%3DoZk9g7KMru2XD5XpUacYVKeg&source=oauth)
You can’t perform that action at this time.
---
# HackMD: Your Collaborative Markdown Workspace for Knowledge Sharing
Build together with Markdown
### Real-time collaboration for
team
personal
technical
research
educational
web3
community
documentation in Markdown
Get HackMD free
I'm sorry; your browser doesn't support HTML video.
###### HackMD is my go-to thinkpad. It's been a great fit for everything from TODO lists to Ethereum devnet specs, drafting blog posts and all types of internal org docs. It's a simple yet versatile product that's a core part of all my workflows!
Tim Beiko,Ethereum Foundation
Accelerate innovation, foster community, and supercharge collaboration with your go-to Markdown editor.
-------------------------------------------------------------------------------------------------------
### Docs
Take notes, create presentations, collaborate virtually – the options are limitless.
Access and share your Markdown documents instantly with flexible permissioning.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fbasic_formatting_en?utm_source=home&utm_medium=feature-highlight&utm_content=Docs)
### Templates
Streamline your work and keep documents clean, clear, and consistent.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fbasic_formatting_en?utm_source=home&utm_medium=feature-highlight&utm_content=Templates)
### Book Mode
Collect and categorize your documents.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fcreate-a-book-en?utm_source=home&utm_medium=feature-highlight&utm_content=Book-Mode)
### GitHub Integration
Keep your documentation and project work in sync with GitHub integrated directly into the Markdown editor.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fsync-a-note-with-github?utm_source=home&utm_medium=feature-highlight&utm_content=GitHub-Integration)
### UML graphs
Visualize research or technical findings for your community.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fuse-mathjax-and-UML-en?utm_source=home&utm_medium=feature-highlight&utm_content=UML-Graph)
### Profile
Publish instantly to turn your profile into a resource for your community.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fpersonal-profile-page-en?utm_source=home&utm_medium=feature-highlight&utm_content=Profile)
Docs
Templates
Book Mode
GitHub Integration
UML graphs
Profile
Millions build with HackMD's Markdown editor every day
------------------------------------------------------
Powering teams around the world, from next-generation startups to established institutions.
### HackMD's simple interface allows novice members to get started quickly.
Students' Community of Information in Southern Taiwan
Join a global movement
======================
Our vibrant Markdown community is researching the next breakthrough, spearheading decentralization, and growing communities around the world.[Learn more](/solutions?utm_source=home&utm_medium=Global-Movement)
1mUsers
30kTeams
170Countries represented
7.7mNotes created
Get started for freePlay around with it first. Pay and add your team later.
[Get started for free](https://hackmd.io/join?signup-event=HomeSignupCompleted)
---
# Forgot your password? · GitHub
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Reset your password
===================
Enter your user account's verified email address and we will send you a password reset link.
Verify your account
-------------------
You can’t perform that action at this time.
---
# GitHub · Build and ship software on a single, collaborative platform · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Build and ship software on a single, collaborative platform
===========================================================
Join the world’s most widely adopted AI-powered developer platform.
Enter your email
Sign up for GitHub
[Try GitHub Copilot](/features/copilot)
GitHub features
---------------
A demonstration animation of a code editor using GitHub Copilot Chat, where the user requests GitHub Copilot to refactor duplicated logic and extract it into a reusable function for a given code snippet.
CodePlanCollaborateAutomateSecure
Code
Build code quickly and more securely with GitHub Copilot embedded throughout your workflows.
GitHub is used by
-----------------
Pause
A Copilot chat window with extensions enabled. The user inputs the @ symbol to reveal a list of five Copilot Extensions. @Sentry is selected from the list, which shifts the window to a chat directly with that extension. There are three sample prompts at the bottom of the chat window, allowing the user to Get incident information, Edit status on incident, or List the latest issues. The last one is activated to send the prompt: @Sentry List the latest issues. The extension then lists several new issues and their metadata.
### Work 55% faster.[Jump to footnote 1](#footnote-1)
Increase productivity with AI-powered coding assistance, including code completion, chat, and more.
[Explore GitHub Copilot](/features/copilot)
Duolingo boosts developer speed by 25% with GitHub Copilot
[Read customer story](/customer-stories/duolingo)
2024 Gartner® Magic Quadrant™ for AI Code Assistants
[Read report](https://www.gartner.com/doc/reprints?id=1-2IKO4MPE&ct=240819&st=sb)
### Automate any workflow
Optimize your process with simple and secured CI/CD.
A list of workflows displays a heading ‘45,167 workflow runs’ at the top. Below are five rows of completed workflows accompanied by their completion time and their duration formatted in minutes and seconds.[Discover GitHub Actions](/features/actions)
### Get up and running in seconds
Start building instantly with a comprehensive dev environment in the cloud.
A GitHub Codespaces setup for the landing page of a game called OctoInvaders. On the left is a code editor with some HTML and Javascript files open. On the right is a live render of the page. In front of this split editor window is a screenshot of two active GitHub Codespaces environments with their branch names and a button to ‘Create codespace on main.’[Check out GitHub Codespaces](/features/codespaces)
### Build on the go
Manage projects and chat with GitHub Copilot from anywhere.
Two smartphone screens side by side. The left screen shows a Notification inbox, listing issues and pull requests from different repositories like TensorFlow and GitHub’s OctoArcade octoinvaders. The right screen shows a new conversation in GitHub Copilot chat.[Download GitHub Mobile](/mobile)
### Integrate the tools you love
Sync with 17,000+ integrations and a growing library of Copilot Extensions.
A grid of fifty app tiles displays logos for integrations and extensions for companies like Stripe, Slack, and Docker. The tiles extend beyond the bounds of the image to indicate a wide array of apps. [Visit GitHub Marketplace](/marketplace)
### Apply fixes in seconds. Spend less time fixing vulnerabilities and more time building features with Copilot Autofix.
[Explore GitHub Advanced Security](/enterprise/advanced-security)
Solve security debt. Leverage AI-assisted security campaigns to reduce application vulnerabilities and zero-day attacks.
[Discover security campaigns](/enterprise/advanced-security)
Dependencies you can depend on. Update vulnerable dependencies with supported fixes for breaking changes.
[Learn about Dependabot](/features/security/software-supply-chain)
Your secrets, your business: protected. Detect, prevent, and remediate leaked secrets across your organization.
[Read about secret scanning](/features/security/code)
### 7x fastervulnerability fixes with GitHub[Jump to footnote 2](#footnote-2)
### 90% coverage[of alert types in all supported languages with Copilot Autofix](https://docs.github.com/en/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites)
### Your workflows, your way. Plan effectively with an adaptable spreadsheet that syncs with your work.
[Jump into GitHub Projects](/features/issues)
“
> It helps us onboard new software engineers and get them productive right away. We have all our source code, issues, and pull requests in one place... GitHub is a complete platform that frees us from menial tasks and enables us to do our best work.
Fabian FaulhaberApplication manager at Mercedes-Benz
### Keep track of your tasks
Create issues and manage projects with tools that adapt to your code.
Display of task tracking within an issue, showing the status of related sub-issues and their connection to the main issue.[Explore GitHub Issues](/features/issues)
### Share ideas and ask questions
Create space for open-ended conversations alongside your project.
A GitHub Discussions thread where a GitHub user suggests a power-up idea involving Hubot revealing a path and protecting Mona. The post has received 5 upvotes and several reactions. Below, three other users add to the discussion, suggesting Hubot could provide different power-ups depending on levels and appreciating the collaboration idea.[Discover GitHub Discussions](/features/discussions)
### Review code changes together
Create review processes that improve code quality and fit neatly into your workflow.
Two code review approvals by helios-ackmore and amanda-knox, which are followed by three successful checks for ‘Build,’ ‘Test,’ and ‘Publish.’[Learn about code review](/features/code-review)
### Fund open source projects
Become an open source partner and support the tools and libraries that power your work.
A GitHub Sponsors popup displays ‘$15,000 a month’ with a progress bar showing 87% towards a $15,000 goal.[Dive into GitHub Sponsors](/sponsors)
By industryBy sizeBy use case
By industry
* * *
[\
\
\
\
Technology\
\
Figma streamlines development and strengthens security\
\
Read customer story](https://github.com/customer-stories/figma)
[\
\
\
\
Automotive\
\
Mercedes-Benz standardizes source code and automates onboarding\
\
Read customer story](https://github.com/customer-stories/mercedes-benz)
[\
\
\
\
Financial services\
\
Mercado Libre cuts coding time by 50%\
\
Read customer story](https://github.com/customer-stories/mercado-libre)
[Explore customer stories](/customer-stories)
* * *
[View all solutions](/solutions)
Millions of developers and businesses call GitHub home
------------------------------------------------------
Whether you’re scaling your development process or just learning how to code, GitHub is where you belong. Join the world’s most widely adopted AI-powered developer platform to build the technologies that redefine what’s possible.
Enter your email
Sign up for GitHub
[Try GitHub Copilot](/features/copilot)
Footnotes
---------
1. [Survey: The AI wave continues to grow on software development teams, 2024.](https://github.blog/news-insights/research/survey-ai-wave-grows/)
[](#footnote-ref-1)
2. This 7X times factor is based on data from the industry’s longest running analysis of fix rates Veracode State of Software Security 2023, which cites the average time to fix 50% of flaws as 198 days vs. GitHub’s fix rates of 72% of flaws with in 28 days which is at a minimum of 7X faster when compared.[](#footnote-ref-2)
[](#hero)
You can’t perform that action at this time.
---
# 403 Forbidden
403 Forbidden
=============
---
# Sign up to GitHub · GitHub
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Create your free account
========================
Explore GitHub's core features for individuals and organizations. See what's included
* Access to GitHub Copilot Increase your productivity and accelerate software development.
* Unlimited repositories Collaborate securely on public and private projects.
* Integrated code reviews Boost code quality with built-in review tools.
* Automated workflows Save time with CI/CD integrations and GitHub Actions.
* Community support Connect with developers worldwide for instant feedback and insights.
Sign up to GitHub
-----------------
Email\*
Password\*
Password should be at least 15 characters OR at least 8 characters including a number and a lowercase letter.
Username\*
Username may only contain alphanumeric characters or single hyphens, and cannot begin or end with a hyphen.
Continue
Verify your account
-------------------
Create account
By creating an account, you agree to the [Terms of Service](/site/terms)
. For more information about GitHub's privacy practices, see the [GitHub Privacy Statement](/site/privacy)
. We'll occasionally send you account-related emails.
You can’t perform that action at this time.
---
# Error
Sorry, something went wrong.
============================
We're working on getting this fixed as soon as we can.
[Go back](//www.facebook.com/)
---
# X / Authorize an application
Authorize HackMD App to access your account?
--------------------------------------------
###  HackMD App
Developer
By HackMD
Application URL
hackmd.io
About this app
Realtime collaborative markdown notes on all platforms.
Privacy Policy
[Privacy Policy](https://hackmd.io/s/privacy)
Terms and Conditions
[Terms and Conditions](https://hackmd.io/s/terms)
Sign in to HackMD App using your account?
**This application will be able to:**
* See Posts from your timeline (including protected Posts) as well as your Lists and collections.
* See your X profile information and account settings.
* See accounts you follow, mute, and block.
* See your email address.
Learn more about third-party app permissions in the [Help Center](https://help.x.com/managing-your-account/connect-or-revoke-access-to-third-party-apps)
.
---
# HackMD Pricing & Plans: Free, Personal, Team, & Enterprise
Build together with Markdown.
Start for free
==============================================
###### For Team
###### For Personal
Choose team size:seats
MonthlyYearly
Free
----
Scale collaboration with your team and community.
$0
==
Free
forever
Up to 3 teammate
[Sign up free](https://hackmd.io/join)
###### What's included:
* Unlimited notes
* 3 invitees
* 3 custom templates
* Suggest edit
* GitHub integration
* 20 GitHub pushes per month
* Customize permalink to your note
* 1MB image file max
Most popular
Prime
-----
Scale collaboration with your team and community.
Save 37.5%
$5
==
seat/
month
Total $15 /monthBilled annually
[Upgrade now](https://hackmd.io/join?create-paid-team=true)
###### \-> Everything in Free, plus:
* Unlimited invites
* Unlimited custom templates
* Unlimited GitHub pushes
* Unlimited versions
* Dedicated storage for images
* Full-text search
* 20K API calls per month
* PDF export
Enterprise
----------
Get exclusive features for your organization
Request a demo
Loading…
###### \-> Everything in Prime, plus:
* Role-based access control
* SSO (SAML, LDAP, customized) login
* Custom domain
* Custom homepage
* GitLab integration
* Custom payment methods
* Dedicated account manager
[Compare all plans](#comparison)
#### 1,000,000+ people around the world build with HackMD
* Compare plans
-------------
* Free
#### $0
Free forever
[Sign up free](https://hackmd.io/join)
* Prime
#### $5
seat/ month
[Upgrade now](https://hackmd.io/join?create-paid-team=true)
* Enterprise
Request a demo
Loading…
| | | | |
| --- | --- | --- | --- |
##### Usage
| Members | | Can be purchased | Can be purchased |
| Invites | 3 | Unlimited | Unlimited |
| Default member permission | | | |
| Versions | Recent 10 versions | Unlimited | Unlimited |
| Custom templates | | | |
| Default note template | | | |
| Default note permissions | | | |
| Trash can timeframe | 3 days | 30 days | 30 days |
| Image storage | Limited cloud image storage | Private cloud image storage | Customizable |
| Full-text search | | | |
| Rendered PDF | | | |
| | | | |
| --- | --- | --- | --- |
##### Integrated workflow
| Push to GitHub | 20 times / month | Unlimited | Unlimited |
| GitLab integration | | | |
| API calls | 2,000 calls / month | 20,000 calls / month | Unlimited |
| | | | |
| --- | --- | --- | --- |
##### Collaboration
| Real-time collaboration | | | |
| Custom note permalink | | | |
| In-line and page commenting | | | |
| Suggest editNew | | | |
| | | | |
| --- | --- | --- | --- |
##### Enterprise management
| SSO (SAML/LDAP) | | | |
| Custom login | | | |
| Role-based access control | | | |
| Custom browser extension server instance | | | |
| Self-hosting | | | |
| Custom domain | | | |
| Custom landing page | | | |
| | | | |
| --- | --- | --- | --- |
##### Support
| Troubleshooting | Knowledge base community and standard email support | Knowledge base community and standard email support | Priority support |
| Invoicing | | | |
| Custom payment solutions | | | |
### HackMD is a powerful and super-convenient collaboration tool. It's rock solid, performant, and easy to use.
Paul Trevithick, Founder & Executive DirectorMee Foundation
FAQ
===
###
###### How do I get started?
When you sign up for HackMD, you're on the Free plan by default. Here you can explore the product and get a feel for how you can use it to level-up your collaboration and documentation. On the Free plan, you can create as many notes as you'd like and invite up to 3 teammates. For more advanced features and more teammate invites, check out the Prime or Enterprise plans.
###
###### Can I change the team size?
###
###### Can I pay for Prime monthly or annually?
###
###### I use HackMD by myself, can I upgrade to Prime?
###
###### Does everyone need a HackMD account to collaborate?
###
###### Does HackMD integrate into my existing workflow?
###
###### Is my data secure?
###
###### My team is a non-profit organization. Is there special pricing available for NPOs or charitable organizations?
###
###### What forms of payment do you accept?
###
###### What happens if a payment fails?
###
###### What happens if I let my HackMD Prime subscription expire?
###
###### Where can I learn more about HackMD?
##### Have more questions?
We'd love to help!
Email us at [support@hackmd.io](mailto:support@hackmd.io)
or reach out on [Discord](https://discord.gg/yDw3AJbmwx)
.
Get started for freePlay around with it first. Pay and add your team later.
[Get started for free](https://hackmd.io/join?signup-event=PricingSignupCompleted)
---
# HackMD for Teams & Businesses
Accelerate innovation in your industryUnlock the power of Markdown no matter your industry. HackMD is the ultimate real-time Markdown editor for builders seeking seamless, efficient collaboration. Document your ideas, improve your workflow, and bring your projects to life with HackMD.
Get HackMD free
#### 1,000,000+ people around the world build with HackMD
[\
\
###### Software Development](?utm_source=solutions&utm_medium=hero-card&utm_content=software-development#software-development)
[\
\
###### Web3](?utm_source=solutions&utm_medium=hero-card&utm_content=web3#web3)
[\
\
###### Research](?utm_source=solutions&utm_medium=hero-card&utm_content=research#research)
[\
\
###### Education](?utm_source=solutions&utm_medium=hero-card&utm_content=education#education)
[\
\
###### Startups](?utm_source=solutions&utm_medium=hero-card&utm_content=startups#startups)
[\
\
###### Non-profits](?utm_source=solutions&utm_medium=hero-card&utm_content=non-profits#non-profits)
HackMD is the Markdown Viewer that GitHub should have built. With no setup, you can track views, embed pseudocode, and even capture private suggestions from anonymous readers. HackMD is an essential tool for me and something I recommend to all technical writers looking to share their thoughts online.
Patrick O'Grady'Ava Labs
HackMD for
Developers
==========
Build like the best. Whether you're calling for feedback on your latest idea, crafting the next breakthrough in tech, or demystifying complex topics, HackMD is the online Markdown editor to help you build with confidence.From our community[Rust](https://hackmd.io/@rust-lang-team?utm_source=solutions&utm_medium=developers&utm_content=Rust)
[Sci-Py](https://hackmd.io/@scientific-python?utm_source=solutions&utm_medium=developers&utm_content=Sci-Py)
[Conda](https://hackmd.io/@conda-community?utm_source=solutions&utm_medium=developers&utm_content=Conda)
[Get HackMD free](https://hackmd.io/join?signup-event=SolutionsSignupCompleted&utm_source=solutions&utm_medium=usecase-card&utm_content=software-development)
HackMD for
Web3
====
Focus on what matters. Build with speed using HackMD's robust Markdown editor. Streamline efforts across remote teams, create community guidelines and bylaws, increase adoption – all from one place.From our community[Vitalik Buterin, Ethereum Foundation](https://notes.ethereum.org/@vbuterin?utm_source=solutions&utm_medium=web3&utm_content=Vitalik)
[Patrick O'Grady, Ava Labs](https://hackmd.io/@patrickogrady?utm_source=solutions&utm_medium=web3&utm_content=Patrick)
[WBNNS, Base](https://hackmd.io/@wbnns?utm_source=solutions&utm_medium=web3&utm_content=WBNNS)
[Get HackMD free](https://hackmd.io/join?signup-event=SolutionsSignupCompleted&utm_source=solutions&utm_medium=usecase-card&utm_content=web3)
HackMD for
Researchers
===========
Harness the power of Markdown to collaborate in real-time, making it easy to draft papers, manage project documentation, and publish findings.From our community[The Turing Way](https://hackmd.io/@turingway?utm_source=solutions&utm_medium=research&utm_content=TuringWay)
[Institute of Space Propulsion NCKU](https://hackmd.io/@ispncku?utm_source=solutions&utm_medium=research&utm_content=ISP)
[Marma J Foundation](https://hackmd.io/@doulos819?utm_source=solutions&utm_medium=research&utm_content=MarmaJ)
[Get HackMD free](https://hackmd.io/join?signup-event=SolutionsSignupCompleted&utm_source=solutions&utm_medium=usecase-card&utm_content=research)
HackMD for
Educators
=========
Empower the next generation of developers. Bridge the gap between education and real world experience with a lightweight online Markdown editor. This interactive and user-friendly platform promotes immediate feedback and active learning.From our community[Brown University](https://hackmd.io/@cs111?utm_source=solutions&utm_medium=education&utm_content=Brown)
[Code Refinery](https://hackmd.io/@coderefinery?utm_source=solutions&utm_medium=education&utm_content=Code%20Refinery)
[NCNU OpenSource](https://hackmd.io/@ncnu-opensource?utm_source=solutions&utm_medium=education&utm_content=NCNU)
[Get HackMD free](https://hackmd.io/join?signup-event=SolutionsSignupCompleted&utm_source=solutions&utm_medium=usecase-card&utm_content=education)
HackMD for
Startups
========
Build your startup with HackMD. You shouldn't have to deal with the frustration of fragmented and outdated documentation. Keep your team in-sync, your docs up-to-date, and your projects on track with HackMD's intuative Markdown editor.From our community[Espresso Systems](https://hackmd.io/@EspressoSystems?utm_source=solutions&utm_medium=startups&utm_content=Espresso)
[Cysic Network](https://hackmd.io/@Cysic?utm_source=solutions&utm_medium=startups&utm_content=Cysic)
[Aztec Network](https://hackmd.io/@aztec-network?utm_source=solutions&utm_medium=startups&utm_content=Aztec)
[Get HackMD free](https://hackmd.io/join?signup-event=SolutionsSignupCompleted&utm_source=solutions&utm_medium=usecase-card&utm_content=startups)
HackMD for
Non-profits
===========
Expand your impact. Collaborate on grant proposals, reports, and strategic plans without worrying about cost. Your non-profit could qualify for our Non-profit Sponsorship Program.From our community[CD Foundation](https://hackmd.io/@cdfoundation?utm_source=solutions&utm_medium=non-profits&utm_content=CDFoundation)
[NF Core](https://hackmd.io/@nf-core?utm_source=solutions&utm_medium=non-profits&utm_content=NFCore)
[UniCourse](https://hackmd.io/@UniCourse?utm_source=solutions&utm_medium=non-profits&utm_content=UniCourse)
[Get HackMD free](https://hackmd.io/join?signup-event=SolutionsSignupCompleted&utm_source=solutions&utm_medium=usecase-card&utm_content=non-profits)
Features that boost productivity
--------------------------------
###### GitHub integration
Sync notes between two powerful tools.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fsync-a-note-with-github)
###### Sign-in with Ethereum
Maintain greater control over your security, data, and digital identity.[Learn more](https://blog.hackmd.io/blog/2024/02/26/sign-in-with-eth-is-live)
###### Comment and suggest edit
Streamline communication and polish docs effortlessly.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fsuggest-edit-en)
###### Team organization
Manage team roles and access to ensure proper permissions in your workspace.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fcreate-and-manage-team)
###### LaTeX and UML
Create UML diagrams and write scientific formulas with plain text, all in one tool.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fuse-mathjax-and-UML-en)
###### Version control
Track every document edit, ensuring easy recall of past changes.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fsave-version-en)
[More features](https://hackmd.io/c/tutorials/%2Fs%2Ftutorials)
What the community is saying
----------------------------
manan@manangouhariI hate how underrated @hackmdio is 🤌
Eric Bishard@httpJunkieCan we just all agree as a community to use @hackmdio? I'm going to write a novel with it.
Adam Sternbach@knowerofmarketsDegens really care about reading posts about blockchain architecture on hackmd
Stephane@thegostepReality unfolds one hackmd doc at a time
pseudo 📜 🇺🇦@pseudotheoshackmd still on top
Adam Sternbach@adamsternbachAs a crypto lawyer who tries to understand tech, HackMD seems to be the alpha.
Duffie Cooley@mauilionThis made me think of @hackmdio which I use to solve this problem all the time.
Barbara ⚢ @geekiedjI really like @hackmdio
jin@dankvrI love @hackmdio, I'm almost at 1200 notes. Best collab note taking app imo I can download all notes and import to Obsidian if I wanted, but I prefer working in public. The bookshelf:
Mike Coutermarsh@msccccI use hackmd so that others can co-write/edit it before it’s “GitHub official”
Abhishek (key/value)@StalwartCoderJust @hackmdio is enough.
Get started for freePlay around with it first. Pay and add your team later.
[Get started for free](https://hackmd.io/join?signup-event=SolutionsSignupCompleted)
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# About HackMD: Our Platform, Mission, & Team
#### About HackMD
The Markdown workspace for innovation
The Markdown workspace for innovation HackMD helps you share ideas, contribute valuable insights, and foster a vibrant community. Here, collaboration drives innovation, helping individuals build their reputation and advance their careers. Through seamless, real-time documentation and knowledge sharing, HackMD bridges the gap between idea and implementation, cultivating an environment where collective intelligence thrives.
#### Our mission is to empower developers to share ideas and build community through knowledge sharing.
In 2014, while completing his master's degree, Max Wu was searching for a secure way to collaborate and document in Markdown. Driven by that challenge, he began creating what would later be known as HackMD. Throughout the following years, he introduced it to friends, colleagues, and online communities, quickly gaining traction and the first outside contributions. Today, over a million people around the world depend on HackMD to document in Markdown, increasing the pace of software development through seamless documentation and collaboration. With HackMD, you can focus on what matters most: building and improving world renown projects.
1mUsers
30kTeams
170Countries represented
7.7mNotes created
#### 1,000,000+ people around the world build with HackMD
Meet the team
=============
##### Jong-kai Yang
Chief Executive Officer and Co-Founder
##### Max Wu
Chief Technology Officer and Co-Founder
[Join the team!](https://www.cakeresume.com/companies/hackmd?locale=en)
Follow us on[](https://www.linkedin.com/company/hackmd)
[](https://x.com/hackmdio)
[](https://facebook.com/hackmdio)
[](https://discord.gg/yDw3AJbmwx)
For media inquiries, please contact us at [press@hackmd.io](mailto:press@hackmd.io)
.
Our investors
=============
Vitalik Buterin
Techstars
SevenX Ventures
AngelList
Global Coin Research
Get started for freePlay around with it first. Pay and add your team later.
[Get started for free](https://hackmd.io/join?signup-event=AboutSignupEndpageCompleted)
---
# HackMD: Your Collaborative Markdown Workspace for Knowledge Sharing
Build together with Markdown
### Real-time collaboration for
team
personal
technical
research
educational
web3
community
documentation in Markdown
Get HackMD free
I'm sorry; your browser doesn't support HTML video.
###### HackMD is my go-to thinkpad. It's been a great fit for everything from TODO lists to Ethereum devnet specs, drafting blog posts and all types of internal org docs. It's a simple yet versatile product that's a core part of all my workflows!
Tim Beiko,Ethereum Foundation
Accelerate innovation, foster community, and supercharge collaboration with your go-to Markdown editor.
-------------------------------------------------------------------------------------------------------
### Docs
Take notes, create presentations, collaborate virtually – the options are limitless.
Access and share your Markdown documents instantly with flexible permissioning.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fbasic_formatting_en?utm_source=home&utm_medium=feature-highlight&utm_content=Docs)
### Templates
Streamline your work and keep documents clean, clear, and consistent.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fbasic_formatting_en?utm_source=home&utm_medium=feature-highlight&utm_content=Templates)
### Book Mode
Collect and categorize your documents.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fcreate-a-book-en?utm_source=home&utm_medium=feature-highlight&utm_content=Book-Mode)
### GitHub Integration
Keep your documentation and project work in sync with GitHub integrated directly into the Markdown editor.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fsync-a-note-with-github?utm_source=home&utm_medium=feature-highlight&utm_content=GitHub-Integration)
### UML graphs
Visualize research or technical findings for your community.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fuse-mathjax-and-UML-en?utm_source=home&utm_medium=feature-highlight&utm_content=UML-Graph)
### Profile
Publish instantly to turn your profile into a resource for your community.[Learn more](https://hackmd.io/c/tutorials/%2F%40docs%2Fpersonal-profile-page-en?utm_source=home&utm_medium=feature-highlight&utm_content=Profile)
Docs
Templates
Book Mode
GitHub Integration
UML graphs
Profile
Millions build with HackMD's Markdown editor every day
------------------------------------------------------
Powering teams around the world, from next-generation startups to established institutions.
### HackMD's simple interface allows novice members to get started quickly.
Students' Community of Information in Southern Taiwan
Join a global movement
======================
Our vibrant Markdown community is researching the next breakthrough, spearheading decentralization, and growing communities around the world.[Learn more](/solutions?utm_source=home&utm_medium=Global-Movement)
1mUsers
30kTeams
170Countries represented
7.7mNotes created
Get started for freePlay around with it first. Pay and add your team later.
[Get started for free](https://hackmd.io/join?signup-event=HomeSignupCompleted)
---
# The HackMD Blog: Home
[](/en/blog/2025/03/12/march-newsletter-blog-2025?utm_source=blog&utm_medium=featured-article)
#en#newsletter
[Markdown your luck with HackMD this March\
=========================================](/en/blog/2025/03/12/march-newsletter-blog-2025?utm_source=blog&utm_medium=featured-article)
Mar 12, 2025ByChaseton Collins
[Read more](/en/blog/2025/03/12/march-newsletter-blog-2025?utm_source=blog&utm_medium=featured-article)
Recent posts
------------
[\
\
#en#use-case\
\
#### How I use HackMD in Open Source projects\
\
Teams and communities are finding success with using HackMD as their go to collaboration platform, read the success story of Co-Chair Contributor Experience at Kubernetes.\
\
Feb 26, 2025ByChaseton Collins](/blog/2025/02/26/how-i-use-hackmd-open-source?utm_source=blog&utm_medium=recent-posts)
[\
\
#en#newsletter\
\
#### Fall in love with documentation this February\
\
Did you miss HackMD's exciting updates over the past month? Catch up on that and more in February's Markdown Memo.\
\
Feb 12, 2025ByChaseton Collins](/blog/2025/02/12/february-newsletter-2025-hackmd?utm_source=blog&utm_medium=recent-posts)
[\
\
#en#community\
\
#### A quick-start guide to community building\
\
Having a following isn’t the same as having a community. This guide walks you through the key steps to define your purpose, choose the right platform, and foster real engagement.\
\
Feb 7, 2025ByChaseton Collins](/blog/2025/02/07/community-quick-start-guide-2025?utm_source=blog&utm_medium=recent-posts)
[\
\
#en#community\
\
#### What is is community building and why does it matter?\
\
Explore what community building is, why it’s important, and how HackMD is fostering communities to empower users and drive growth.\
\
Jan 30, 2025ByChaseton Collins](/blog/2025/01/30/community-building-hackmd-2025?utm_source=blog&utm_medium=recent-posts)
[\
\
#en#use-case\
\
#### HackMD & Obsidian: The ultimate markdown workflow\
\
Limiting yourself to a single markdown tool might restrict your productivity and workflow. Discover how combining the strengths of top markdown editors, HackMD and Obsidian, can enhance your projects and speed up your feedback process.\
\
Jan 22, 2025ByChaseton Collins](/blog/2025/01/22/hackmd-obsidian-workflow?utm_source=blog&utm_medium=recent-posts)
[\
\
#en#product\
\
#### Introducing Folders: A better way to organize your workspace\
\
HackMD just got an upgrade! Introducing Folders, the feature you’ve been asking for to transform your workspace into an organized haven. With Folders, you can group notes by projects, timeframes, or categories, creating a cleaner, more intuitive workspace.\
\
Jan 13, 2025ByRachel Golden](/blog/2025/01/13/folder-announcement-markdown?utm_source=blog&utm_medium=recent-posts)
12315
Subscribe to our newsletter
---------------------------
Build with confidence. Never miss a beat. Learn about the latest product updates, company happenings, and technical guides in our monthly newsletter.
Subscribe
Changelog
---------
[View Changelog](/changelog?utm_source=blog&utm_medium=Changelog-view)
[#### Track Every Edit with Show Edit History\
\
Get more organized with folders.\
\
Feb 19, 2025](/changelog?utm_source=blog&utm_medium=Changelog-article#2025-02-19)
[#### Get more organized with folders\
\
Get more organized with folders.\
\
Jan 7, 2025](/changelog?utm_source=blog&utm_medium=Changelog-article#2025-01-07)
[#### The streamlined Floating Toolbar\
\
Personalize your reading experience with new Light and Dark modes, and explore our brand new NeoLight and NeoDark color themes for the editor.\
\
Nov 7, 2024](/changelog?utm_source=blog&utm_medium=Changelog-article#2024-11-07)
[#### New Themes & Reading Experience\
\
Personalize your reading experience with new Light and Dark modes, and explore our brand new NeoLight and NeoDark color themes for the editor.\
\
Jun 27, 2024](/changelog?utm_source=blog&utm_medium=Changelog-article#2024-06-27)
Get started for freePlay around with it first. Pay and add your team later.
[Get started for free](https://hackmd.io/join?signup-event=BlogSignupCompleted)
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# Sign in to GitHub · GitHub
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Sign in to GitHub
=================
Username or email address
Password [Forgot password?](/password_reset)
Password login alternatives
---------------------------
Sign in with a passkey
New to GitHub? [Create an account](/signup?source=login)
You can’t perform that action at this time.
---
# Sign in to GitHub · GitHub
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Sign in to GitHub
=================
Username or email address
Password [Forgot password?](/password_reset)
Password login alternatives
---------------------------
Sign in with a passkey
New to GitHub? [Create an account](/join?return_to=%2Flogin%2Foauth%2Fauthorize%3Fclient_id%3Df47f304f25add575a164%26redirect_uri%3Dhttps%253A%252F%252Fhackmd.io%252Fauth%252Fgithub%252Fcallback%26response_type%3Dcode%26state%3DoZk9g7KMru2XD5XpUacYVKeg&source=oauth)
You can’t perform that action at this time.
---
# Error
Sorry, something went wrong.
============================
We're working on getting this fixed as soon as we can.
[Go back](//www.facebook.com/)
---
# HackMD Tutorial Book - HackMD
HackMD Tutorial Book === \*\*\[中文版\](/c/tutorials-tw)\*\* - \[Welcome\](/s/tutorials) - \[Features\](/s/features) Feel free to leave comments below to request for (or contribute) tutorials on certain topics. You can also leave comments below each tutorial to ask for clarifications or report bugs. If you want a quick overview of all features, visit \[features\](/features) :::info Support email: :email: support@hackmd.io ::: New Feature 🔥 --- - \[Folder 🗂️\](/@docs/folder-en) - \[Copy paragraph link\](/@docs/paragraph\_link\_copy\_en) API 🦾 --- - \[How to issue/revoke an API token?\](/@docs/issue-revoke-api-token-en) - \[Developer Portal\](/@hackmd-api/developer-portal?utm\_source=tutorial&utm\_medium=book-section) \[target=\_blank\] Introduction --- - \[Registration and binding\](/@docs/registration\_and\_binding\_en) - \[Choose your interface language\](/@docs/interface-language-en) - \[Workspace introduction\](/@docs/workspace-introduction-en) - \[Dark Mode\](/@docs/how-to-set-dark-mode-en) - \[Manage profile page\](/@docs/personal-profile-page-en) - \[Navigation bar intro\](/@docs/editor\_en) - \[View note directory\](/@docs/view-en) - \[How to edit metadata of a note\](/@docs/how-to-edit-metadata-of-a-note-en) - \[How to edit title and tags\](/@docs/how-to-edit-title-and-tags-en) Tips for using HackMD --- - \[How to use Tag List and Tag Filter\](/@docs/how-to-use-tag-list-filter-en) - \[How to Follow\](/@docs/how-to-follow-en) - \[Spotlight\](/@hackmd/spotlight-en) - \[Use Regular Expression to search the in text editor\](/@docs/regular-expression-to-search-en) - \[Tips for editing on mobile phone\](/@docs/rJ5BU988A) - \[Embed another note\](/@docs/embed-another-note-en) - \[Keyboard shortcuts\](/@docs/keyboard-shortcuts) - \[Offline Access\](/@docs/offline-access-en) Text Editor --- - \[Basic Formatting: Title, Quotation, Bold Text\](/@docs/basic\_formatting\_en) - \[Highlighting, color blocks, and collapsing\](/@docs/enhance\_content\_en) - \[Insert image in notes\](/@docs/insert-image-in-team-note) - \[Embed YouTube, link notes, and more\](/@docs/insert-external-media-en) - \[Search and replace\](/@docs/search-and-replace-en) - \[Emoji cheat sheet\](https://github.com/ikatyang/emoji-cheat-sheet) \[target=\_blank\] - \[Changing text color\](/@docs/change-text-color-en) - \[How to create table\](/@docs/how-to-create-table-en) - \[How to paste table from Excel \](/@docs/paste-table-from-excel-en) - \[Copy and paste code into your notes\](/@docs/insert-code-into-note-en) Book Mode & Slide Mode 📍 --- - \[How to create a book\](/@docs/create-a-book-en) - \[How to create a slide deck\](/@docs/create-slides-en) Creating graphs 🖍️ --- - \[How to use MathJax & UML\](/@docs/use-mathjax-and-UML-en) - \[How to create flowchart\](/@docs/flowchart-en) - \[How to create pie chart\](/@docs/pie-chart-en) - \[How to create Gantt chart\](/@docs/gantt-chart-en) Notes Management & Template 📚 --- - \[Deleting and Restoring Notes\](/@docs/delete-note-en) - \[Folder\](/@docs/folder-en) - \[How to use template\](/@docs/how-to-use-template-en) - \[How to save versions\](/@docs/save-version-en) - \[How to export & import notes\](/@docs/export-and-import-notes-en) - \[How to export to PDF\](/@docs/export-to-pdf-en) - \[How to import from/export to Arweave\](/@docs/export-import-arweave-en) - \[Publish with permalink\](/@docs/publish-notes-with-permalink-en) Team Workspace 🚀 --- - \[What is Team?\](/@docs/what-is-team) - \[Create and manage Team\](/@docs/create-and-manage-team) - \[Manage Team notes\](/@docs/manage-team-notes) - \[Insert image in Team notes\](/@docs/insert-image-in-team-note) - \[Unlock Team member limit\](/@docs/unlock-team-member-limit) - \[How to Transfer Team Ownership\](/@docs/transfer-team-ownership-en) Collaboration 🤝 --- - \[Invite others to a private note\](/@docs/invite-others-to-a-private-note-en) - \[Live Host a Collaborative Session\](/@docs/hosting-a-collaborative-session-en) - \[Use comments to collaborate asynchronously\](/@docs/comment-to-collaborate-en) - \[Hide and Resolve comments\](/@docs/hide-resolve-comment-en) - \[How to Raise a Suggest Edit\](/@docs/suggest-edit-en) Pricing and Payment 💍 --- - \[Personal Prime subscription and management\](/@docs/Personal-Prime-subscription-management-en) - \[Subscribe to Team Prime Plan\](/@docs/unlock-team-member-limit) - \[FAQ about yearly payment\](/@docs/yearly-payment-faq-en) - \[How to apply for non-profit sponsorship?\](/@docs/NPOplan) Account --- - \[How to merge accounts?\](/@docs/merge-accounts-en) - \[How to delete my account\](/@docs/delete-my-account-en) Advance Features 🛠️ --- - \[How to sync with GitHub\](/@docs/sync-a-note-with-github) - \[Command line tool: hackmd-cli\](/@docs/hackmd-cli) - \[Browser extension: HackMD-it\](/@docs/browser-extension-en) - \[How to turn on the feature preview\](/@docs/feature-preview)
{"breaks":true,"title":"HackMD Tutorial Book","description":"Learn how to use HackMD with tutorials covering all aspects of the powerful markdown editor.","image":"https://hackmd.io/\_uploads/SyBv-nInC.jpg","contributors":"\[{\\"id\\":\\"9fb45a0a-ff1a-49af-9ba3-dc411256dc2b\\",\\"add\\":2247,\\"del\\":1352},{\\"id\\":\\"61af98f4-b303-4819-b08b-aa32cf6677a8\\",\\"add\\":788,\\"del\\":336},{\\"id\\":\\"b69c1c71-1f6f-41b4-b230-8f8f857d1db7\\",\\"add\\":92,\\"del\\":0},{\\"id\\":\\"3ab19145-8243-4557-8f3e-70a733b710c0\\",\\"add\\":364,\\"del\\":0},{\\"id\\":\\"7252c271-4d52-435d-b724-900478f7cef4\\",\\"add\\":1228,\\"del\\":345},{\\"id\\":\\"6d3b4625-23c8-4275-a28e-cdc2cb546eda\\",\\"add\\":466,\\"del\\":49},{\\"id\\":\\"23942b32-8d81-4d00-ae9b-702abb782e84\\",\\"add\\":125,\\"del\\":32},{\\"id\\":\\"d7bc100e-ab59-4c37-948d-734e8e215f68\\",\\"add\\":17815,\\"del\\":16560},{\\"id\\":\\"1fb5b07b-07b2-4267-92c0-d31539e3d000\\",\\"add\\":154,\\"del\\":38}\]"}
[](https://hackmd.io/tutorials "Edit")
Expand menu
---
# 403 Forbidden
403 Forbidden
=============
---
# Error
Sorry, something went wrong.
============================
We're working on getting this fixed as soon as we can.
[Go back](//www.facebook.com/)
---
# 403 Forbidden
403 Forbidden
=============
---
# GitHub General Privacy Statement - GitHub Docs
[Skip to main content](#main-content)
GitHub General Privacy Statement
================================
In this article
---------------
[GitHub Privacy Statement](#github-privacy-statement)
------------------------------------------------------
Effective date: February 1, 2024
Welcome to the GitHub Privacy Statement. This is where we describe how we handle your “Personal Data”, which is information that is directly linked or can be linked to you. It applies to the Personal Data that GitHub, Inc. or GitHub B.V., processes as the “Data Controller” when you interact with websites, applications, and services that display this Statement (collectively, “Services”). This Statement does not apply to services or products that do not display this Statement, such as Previews, where relevant.
### [End User Notice: Organization-Provided GitHub Accounts](#end-user-notice-organization-provided-github-accounts)
When a school or employer supplies your GitHub account, they assume the role of Data Controller for most Personal Data used in our Services. This enables them to:
* Manage and administer your GitHub account, including adjusting privacy settings.
* Access and utilize your Personal Data, which includes details on how you use the Services, as well as your content and files.
Should you access a GitHub Service through an account provided by an organization, such as your employer or school, the organization becomes the Data Controller, and this Privacy Statement's direct applicability to you changes. Even so, GitHub remains dedicated to preserving your privacy rights. In such circumstances, GitHub functions as a Data Processor, adhering to the Data Controller's instructions regarding your Personal Data's processing. A Data Protection Agreement governs the relationship between GitHub and the Data Controller. For further details regarding their privacy practices, please refer to the privacy statement of the organization providing your account.
In cases where your organization grants access to GitHub products, GitHub acts as the Data Controller solely for specific processing activities. These activities are clearly defined in a contractual agreement with your organization, known as a Data Protection Agreement. You can review our standard Data Protection Agreement at [GitHub Data Protection Agreement](https://github.com/customer-terms/github-data-protection-agreement)
. For those limited purposes, this Statement governs the handling of your Personal Data. For all other aspects of GitHub product usage, your organization's policies apply.
### [Third Party Access and Data Protection](#third-party-access-and-data-protection)
When you use third-party extensions, integrations, or follow references and links within our Services, the privacy policies of these third parties apply to any Personal Data you provide or consent to share with them. Their privacy statements will govern how this data is processed.
[Personal Data We Collect](#personal-data-we-collect)
------------------------------------------------------
Personal Data is collected from you directly, automatically from your device, and also from third parties. The Personal Data GitHub processes when you use the Services depends on variables like how you interact with our Services (such as through web interfaces, desktop or mobile applications), the features you use (such as pull requests, Codespaces, or GitHub Copilot) and your method of accessing the Services (your preferred IDE). Below, we detail the information we collect through each of these channels:
### [From You](#from-you)
* Account Data: We collect certain information when you open an account such as your GitHub handle, name, email address, password, payment information and transaction information.
* User Content and Files: When you use our Services, we collect Personal Data included as part of the information you provide such as code, inputs, text, documents, images, or feedback.
* Demographic information: In some cases, you provide us with ethnicity, gender, or similar demographic details.
* Feedback Data: This consists of information you submit through surveys, reviews, or interactive features.
* Payment Information: For paid subscriptions, we collect details like name, billing address, and payment specifics.
* Profile Information: We collect information to create a user profile, which may include a photo, additional email addresses, job title, or biography.
* Sales and Marketing Data: This includes information provided for promotional communications, such as name, email address, and company name.
* Support Data: When you seek customer support, we collect details like code, text, or multimedia files.
### [Automatically](#automatically)
* Buttons, Tools, and Content from Other Companies: Our Services may contain links or buttons that lead to third-party services like Twitter or LinkedIn. Use of these features may result in data collection. Engaging with these buttons, tools, or content may automatically send certain browser information to these companies. Please review the privacy statements of these companies for more information.
* Essential Cookies and Similar Tracking Technologies: We use cookies and similar technologies to provide essential functionality like storing settings and recognizing you while using our Services.
* Non-essential Cookies: Depending on your jurisdiction, we may use online analytics products that use cookies to help us analyze how de-identified users use our Services and to enhance your experience when you use the Services. We may also employ third-party Cookies to gather data for interest-based advertising. In some jurisdictions, we only use non-essential cookies after obtaining your consent. See [this](#what-are-your-cookie-choices-and-controls)
section for more details and control options.
* Email Marketing Interactions: Our emails may have web beacons that offer information on your device type, email client, email reception, opens, and link clicks.
* Geolocation Information: Depending on the Service's functionality, we collect regional geolocation data.
* Service Usage Information: We collect data about your interactions with the Services, such as IP address, device information, session details, date and time of requests, device type and ID, operating system and application version, information related to your contributions to repositories, and performance of specific features or Services.
* Website Usage Data: We automatically log data about your Website interactions, including the referring site, date and time of visit, pages viewed, and links clicked.
### [From Third Parties](#from-third-parties)
* Information from Other Users of the Services: Other users may share information about you when they submit issues and comments. We may also receive information about you if you are identified as a representative or administrator on your company's account.
* Publicly Available Sources: We may acquire information about you from publicly available sources like public GitHub repositories.
* Services you linked to your GitHub account: When you or your administrator integrate third-party apps or services with our Services, we receive information based on your settings with those services. This can include details like your name and email from services like Google for authentication. The information we receive depends on the third-party's settings and privacy policies. Always review these to understand what data is shared with our Services.
* Vendors, Partners, and Affiliates: We may receive information about you from third parties, like vendors, resellers, partners, or affiliates for the purposes outlined in this statement.
[Processing Purposes: How We Use Your Personal Data](#processing-purposes-how-we-use-your-personal-data)
---------------------------------------------------------------------------------------------------------
The Personal Data we process depends on your interaction and access methods with our Services, including the interfaces (web, desktop, mobile apps), features used (pull requests, Codespaces, GitHub Copilot), and your preferred access tools (like your IDE). This section details all the potential ways GitHub may process your Personal Data:
* Business Operations: We use Personal Data for activities like billing, accounting, and compensation. This includes creating aggregated statistical data for internal reporting, financial reporting, revenue planning, capacity planning, and forecast modeling (including product strategy).
* Communication: We use Personal Data to inform you about new Services, features, offers, promotions, and other pertinent information. This also includes sending confirmations, invoices, technical notices, updates, security alerts, and administrative messages.
* Inference: We generate new information from other data we collect to derive likely preferences or other characteristics. For instance, we infer your general geographic location based on your IP address.
* Personalization: We use Personal Data to customize the Service to your preferences, to evaluate the effectiveness of enterprise business ads and promotional communications, and to ensure a seamless and consistent user experience.
* Safety and Security: To promote safety, integrity, and security across our Services, we process Personal Data, using both automated and, at times, manual techniques for abuse detection, prevention, and violations of terms of service.
* Service Provision: We use Personal Data to deliver and update our Services as configured and used by You, and to make ongoing personalized experiences and recommendations.
* Troubleshooting: We use Personal Data to identify and resolve technical issues.
* Ongoing Service Performance: Personal Data helps us keep the Services up to date and performant, and meet user productivity, reliability, efficacy, quality, privacy, accessibility and security needs.
* Complying with and resolving legal obligations: including responding to Data Subject Requests for Personal Data processed by GitHub as Controller (for example website data), tax requirements, agreements and disputes.
* Delivering Professional Services: We use Personal Data to deliver training, consulting or implementation (“Professional Services”). This includes providing technical support, professional planning, advice, guidance, data migration, deployment, and solution/software development services.
* Improving Professional Services: Enhancing delivery, efficacy, quality, and security of Professional Services and the underlying product(s) based on issues identified while providing Professional Services, including fixing software defects, and otherwise keeping the Professional Services up to date and performant.
When carrying out these activities, GitHub practices data minimization and uses the minimum amount of Personal Information required.
[Sharing of Personal Data](#sharing-of-personal-data)
------------------------------------------------------
We may share Personal Data with the following recipients:
* Abuse and Fraud Prevention Entities: We may disclose Personal Data based on a good faith belief it is needed to prevent fraud, abuse, or attacks on our Services, or to protect the safety of GitHub and our users.
* Affiliates: Personal Data may be shared with GitHub affiliates, including Microsoft, to facilitate customer service, marketing and advertising, order fulfillment, billing, technical support, and legal and compliance obligations. Our affiliates may only use the Personal Data in a manner consistent with this Privacy Statement.
* GitHub Organization Accounts: If an organization adds you to their GitHub account, we might share Personal Data with that organization to fulfill the commercial relationship. In such a case, your use of the Services is protected by a data protection agreement and terms between your organization and GitHub
* Competent Authorities: We may disclose Personal Data to authorized law enforcement, regulators, courts, or other public authorities in response to lawful requests or to protect our rights and safety. Please refer to our [Guidelines for Legal Requests of User Data](https://docs.github.com/en/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data)
for more information.
* Corporate Transaction Entities: we might disclose Personal Data within the limits of the law and in accordance with this Privacy Statement for strategic business transactions such as sales or a merger.
* Partners and Resellers: We cooperate with third-parties that offer sales, consulting, support, and technical services for our Services. We may share your data with these partners and resellers where allowed, and with your consent when required.
* Subprocessors and Service Providers: We may use vendors to provide services on our behalf, including hosting, marketing, advertising, social, analytics, support ticketing, credit card processing, or security services. They are bound by contractual obligations to ensure the security, privacy, and confidentiality of your information. Please visit [https://docs.github.com/en/site-policy/privacy-policies/github-subprocessors](https://docs.github.com/en/site-policy/privacy-policies/github-subprocessors)
to see our list of Subprocessors.
* Visual Studio Code (GitHub Codespaces): GitHub Codespaces and github.dev offer Visual Studio Code in a web browser, where some telemetry is collected by default. Details on telemetry collection are on the [VS Code website](https://code.visualstudio.com/docs/getstarted/telemetry)
. To opt out, go to File > Preferences > Settings in the top left menu of VS Code. Opting out will sync this preference across all future web sessions in GitHub Codespaces and github.dev.
* Other Third-party Applications: Upon your instruction, we may share Personal Data with third-party applications available on our Marketplace. You are responsible for the data you instruct us to share with these applications.
* Other Users and the Public: Depending on your account settings, we may share Personal Data with other users of the Services and the public. You control what information is made public. To adjust your settings, visit User Settings in your profile. Please be aware that any information you share in a collaborative context may become publicly accessible.
[Private repositories: GitHub Access](#private-repositories-github-access)
---------------------------------------------------------------------------
If your GitHub account has private repositories, you control the access to that information. GitHub personnel does not access private repository information without your consent except as provided in this Privacy Statement and for:
* security purposes
* automated scanning or manual review for known vulnerabilities, active malware, or other content known to violate our Terms of Service
* to assist the repository owner with a support matter
* to maintain the integrity of the Services, or
* to comply with our legal obligations if we have reason to believe the contents are in violation of the law.
GitHub will provide you with notice regarding private repository access unless doing so is prohibited by law or if GitHub acted in response to a security threat or other risk to security.
[Lawful Bases for Processing Personal Data (Applicable to EEA and UK End Users)](#lawful-bases-for-processing-personal-data-applicable-to-eea-and-uk-end-users)
----------------------------------------------------------------------------------------------------------------------------------------------------------------
GitHub processes Personal Data in compliance with the GDPR, ensuring a lawful basis for each processing activity. The basis varies depending on the data type and the context, including how you access the services. Our processing activities typically fall under these lawful bases:
* Contractual Necessity: Processing is required to fulfill our contractual duties to you, in accordance with the GitHub Terms of Service.
* Legal Obligation: We process data when it's necessary to comply with applicable laws or to protect the rights, safety, and property of GitHub, our affiliates, users, or third parties.
* Legitimate Interests: We process data for purposes that are in our legitimate interests, such as securing our Services, communicating with you, and improving our Services. This is done only when these interests are not overridden by your data protection rights or your fundamental rights and freedoms.
* Consent: We process data when you have explicitly consented to such processing. When we rely on consent as the legal basis, you have the right to withdraw your consent for data processing at any time. The procedures for withdrawal are detailed in this Statement and available on our website.
[Your Privacy Rights](#your-privacy-rights)
--------------------------------------------
Depending on your residence location, you may have specific legal rights regarding your Personal Data:
* The right to access the data collected about you
* The right to request detailed information about the specific types of Personal Data we've collected over the past 12 months, including data disclosed for business purposes
* The right to rectify or update inaccurate or incomplete Personal Data under certain circumstances
* The right to erase or limit the processing of your Personal Data under specific conditions
* The right to object to the processing of your Personal Data, as allowed by applicable law
* The right to withdraw consent, where processing is based on your consent
* The right to receive your collected Personal Data in a structured, commonly used, and machine-readable format to facilitate its transfer to another company, where technically feasible
To exercise these rights, please send an email to privacy\[at\]github\[dot\]com and follow the instructions provided. To verify your identity for security, we may request extra information before addressing your data-related request. Please contact our Data Protection Officer at dpo\[at\]github\[dot\]com for any feedback or concerns. Depending on your region, you have the right to complain to your local Data Protection Authority. European users can find authority contacts on the European Data Protection Board website, and UK users on the Information Commissioner’s Office website.
We aim to promptly respond to requests in compliance with legal requirements. Please note that we may retain certain data as necessary for legal obligations or for establishing, exercising, or defending legal claims.
[International data transfers](#international-data-transfers)
--------------------------------------------------------------
GitHub stores and processes Personal Data in a variety of locations, including your local region, the United States, and other countries where GitHub, its affiliates, subsidiaries, or subprocessors have operations. We transfer Personal Data from the European Union, the United Kingdom, and Switzerland to countries that the European Commission has not recognized as having an adequate level of data protection. When we engage in such transfers, we generally rely on the standard contractual clauses published by the European Commission under [Commission Implementing Decision 2021/914](https://eur-lex.europa.eu/eli/dec_impl/2021/914/oj)
, to help protect your rights and enable these protections to travel with your data. To learn more about the European Commission’s decisions on the adequacy of the protection of personal data in the countries where GitHub processes personal data, see this article on the [European Commission website](https://commission.europa.eu/law/law-topic/data-protection/international-dimension-data-protection/adequacy-decisions_en)
.
[Data Privacy Framework (DPF)](#data-privacy-framework-dpf)
------------------------------------------------------------
GitHub also complies with the EU-U.S. Data Privacy Framework (EU-U.S. DPF), the UK Extension to the EU-U.S. DPF, and the Swiss-U.S. Data Privacy Framework (Swiss-U.S. DPF) as set forth by the U.S. Department of Commerce. GitHub has certified to the U.S. Department of Commerce that it adheres to the EU-U.S. Data Privacy Framework Principles (EU-U.S. DPF Principles) with regard to the processing of personal data received from the European Union in reliance on the EU-U.S. DPF and from the United Kingdom (and Gibraltar) in reliance on the UK Extension to the EU-U.S. DPF. GitHub has certified to the U.S. Department of Commerce that it adheres to the Swiss-U.S. Data Privacy Framework Principles (Swiss-U.S. DPF Principles) with regard to the processing of personal data received from Switzerland in reliance on the Swiss-U.S. DPF. If there is any conflict between the terms in this privacy statement and the EU-U.S. DPF Principles and/or the Swiss-U.S. DPF Principles, the Principles shall govern. To learn more about the Data Privacy Framework (DPF) program, and to view our certification, please visit [https://www.dataprivacyframework.gov/](https://www.dataprivacyframework.gov/)
.
GitHub has the responsibility for the processing of Personal Data it receives under the Data Privacy Framework (DPF) Principles and subsequently transfers to a third party acting as an agent on GitHub’s behalf. GitHub shall remain liable under the DPF Principles if its agent processes such Personal Data in a manner inconsistent with the DPF Principles, unless the organization proves that it is not responsible for the event giving rise to the damage.
### [Dispute resolution process](#dispute-resolution-process)
In compliance with the EU-U.S. DPF, the UK Extension to the EU-U.S. DPF, and the Swiss-U.S. DPF, GitHub commits to resolve DPF Principles-related complaints about our collection and use of your personal information. EU, UK, and Swiss individuals with inquiries or complaints regarding our handling of personal data received in reliance on the EU-U.S. DPF, the UK Extension, and the Swiss-U.S. DPF should first contact GitHub at: dpo\[at\]github\[dot\]com.
If you do not receive timely acknowledgment of your DPF Principles-related complaint from us, or if we have not addressed your DPF Principles-related complaint to your satisfaction, please visit [https://go.adr.org/dpf\_irm.html](https://go.adr.org/dpf_irm.html)
for more information or to file a complaint. The services of the International Centre for Dispute Resolution are provided at no cost to you.
An individual has the possibility, under certain conditions, to invoke binding arbitration for complaints regarding DPF compliance not resolved by any of the other DPF mechanisms. For additional information visit [https://www.dataprivacyframework.gov/s/article/ANNEX-I-introduction-dpf?tabset-35584=2](https://www.dataprivacyframework.gov/s/article/ANNEX-I-introduction-dpf?tabset-35584=2)
.
### [Government Enforcement](#government-enforcement)
GitHub is subject to the investigatory and enforcement powers of the Federal Trade Commission (FTC). Under Section 5 of the Federal Trade Commission Act (15 U.S.C. § 45), an organization's failure to abide by commitments to implement the DPF Principles may be challenged as deceptive by the FTC. The FTC has the power to prohibit such misrepresentations through administrative orders or by seeking court orders.
[Security and Retention](#security-and-retention)
--------------------------------------------------
GitHub uses appropriate administrative, technical, and physical security controls to protect your Personal Data. We’ll retain your Personal Data as long as your account is active and as needed to fulfill contractual obligations, comply with legal requirements, resolve disputes, and enforce agreements. The retention duration depends on the purpose of data collection and any legal obligations.
[Security](#security)
----------------------
GitHub uses administrative, technical, and physical security controls where appropriate to protect your Personal Data.
[Contact Us](#contact-us)
--------------------------
Contact us via our contact form or by emailing our Data Protection Officer at dpo\[at\]github\[dot\]com. Our addresses are:
GitHub B.V. Prins Bernhardplein 200, Amsterdam 1097JB The Netherlands
GitHub, Inc. 88 Colin P. Kelly Jr. St. San Francisco, CA 94107 United States
[Information for Minors](#information-for-minors)
--------------------------------------------------
Our Services are not intended for individuals under the age of 13. We do not intentionally gather Personal Data from such individuals. If you become aware that a minor has provided us with Personal Data, please [notify us](https://support.github.com/contact/privacy)
.
[Changes to Our Privacy Statement](#changes-to-our-privacy-statement)
----------------------------------------------------------------------
GitHub may periodically revise this Privacy Statement. If there are material changes to the statement, we will provide at least 30 days prior notice by updating our website or sending an email to your primary email address associated with your GitHub account.
[Translations](#translations)
------------------------------
Below are translations of this document into other languages. In the event of any conflict, uncertainty, or apparent inconsistency between any of those versions and the English version, this English version is the controlling version.
### [French](#french)
Cliquez ici pour obtenir la version française: [Déclaration de confidentialité de GitHub (PDF)](/assets/images/help/site-policy/github-privacy-statement(07.22.20)(fr).pdf)
.
### [Other translations](#other-translations)
For translations of this statement into other languages, please visit [https://docs.github.com/](https://docs.github.com/)
and select a language from the drop-down menu under “English.”
[Our use of cookies and tracking technologies](#our-use-of-cookies-and-tracking-technologies)
----------------------------------------------------------------------------------------------
### [Cookies and tracking technologies](#cookies-and-tracking-technologies)
GitHub uses cookies to provide, secure and improve our Service or to develop new features and functionality of our Service. For example, we use them to (i) keep you logged in, (ii) remember your preferences, (iii) identify your device for security and fraud purposes, including as needed to maintain the integrity of our Service, (iv) compile statistical reports, and (v) provide information and insight for future development of GitHub. We provide more information about [cookies on GitHub](https://github.com/privacy/cookies)
that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies.
For Enterprise Marketing Pages, we may also use non-essential cookies to (i) gather information about enterprise users’ interests and online activities to personalize their experiences, including by making the ads, content, recommendations, and marketing seen or received more relevant and (ii) serve and measure the effectiveness of targeted advertising and other marketing efforts. If you disable the non-essential cookies on the Enterprise Marketing Pages, the ads, content, and marketing you see may be less relevant.
Our emails to users may contain a pixel tag, which is a small, clear image that can tell us whether or not you have opened an email and what your IP address is. We use this pixel tag to make our email communications more effective and to make sure we are not sending you unwanted email.
The length of time a cookie will stay on your browser or device depends on whether it is a “persistent” or “session” cookie. Session cookies will only stay on your device until you stop browsing. Persistent cookies stay until they expire or are deleted. The expiration time or retention period applicable to persistent cookies depends on the purpose of the cookie collection and tool used. You may be able to delete cookie data. For more information, see [GitHub General Privacy Statement](/en/site-policy/privacy-policies/github-privacy-statement#what-are-your-cookie-choices-and-controls)
.
#### [What are cookies and similar technologies?](#what-are-cookies-and-similar-technologies)
We use cookies and similar technologies, such as web beacons, local storage, and mobile analytics, to operate and provide our Services. When visiting Enterprise Marketing Pages, like resources.github.com, these and additional cookies, like advertising IDs, may be used for sales and marketing purposes.
Cookies are small text files stored by your browser on your device. A cookie can later be read when your browser connects to a web server in the same domain that placed the cookie. The text in a cookie contains a string of numbers and letters that may uniquely identify your device and can contain other information as well. This allows the web server to recognize your browser over time, each time it connects to that web server.
Web beacons are electronic images (also called “single-pixel” or “clear GIFs”) that are contained within a website or email. When your browser opens a webpage or email that contains a web beacon, it automatically connects to the web server that hosts the image (typically operated by a third party). This allows that web server to log information about your device and to set and read its own cookies. In the same way, third-party content on our websites (such as embedded videos, plug-ins, or ads) results in your browser connecting to the third-party web server that hosts that content.
Mobile identifiers for analytics can be accessed and used by apps on mobile devices in much the same way that websites access and use cookies. When visiting Enterprise Marketing pages, like resources.github.com, on a mobile device these may allow us and our third-party analytics and advertising partners to collect data for sales and marketing purposes.
We may also use so-called “flash cookies” (also known as “Local Shared Objects” or “LSOs”) to collect and store information about your use of our Services. Flash cookies are commonly used for advertisements and videos.
#### [How do we and our partners use cookies and similar technologies?](#how-do-we-and-our-partners-use-cookies-and-similar-technologies)
The GitHub Services use cookies and similar technologies for a variety of purposes, including to store your preferences and settings, enable you to sign-in, analyze how our Services perform, track your interaction with the Services, develop inferences, combat fraud, and fulfill other legitimate purposes. Some of these cookies and technologies may be provided by third parties, including service providers and advertising partners. For example, our analytics and advertising partners may use these technologies in our Services to collect personal information (such as the pages you visit, the links you click on, and similar usage information, identifiers, and device information) related to your online activities over time and across Services for various purposes, including targeted advertising. GitHub will place non-essential cookies on pages where we market products and services to enterprise customers, for example, on resources.github.com.
We and/or our partners also share the information we collect or infer with third parties for these purposes.
The table below provides additional information about how we use different types of cookies:
| Purpose | Description |
| --- | --- |
| Required Cookies | GitHub uses required cookies to perform essential website functions and to provide the services. For example, cookies are used to log you in, save your language preferences, provide a shopping cart experience, improve performance, route traffic between web servers, detect the size of your screen, determine page load times, improve user experience, and for audience measurement. These cookies are necessary for our websites to work. |
| Analytics | We allow third parties to use analytics cookies to understand how you use our websites so we can make them better. For example, cookies are used to gather information about the pages you visit and how many clicks you need to accomplish a task. We also use some analytics cookies to provide personalized advertising. |
| Social Media | GitHub and third parties use social media cookies to show you ads and content based on your social media profiles and activity on GitHub’s websites. This ensures that the ads and content you see on our websites and on social media will better reflect your interests. This also enables third parties to develop and improve their products, which they may use on websites that are not owned or operated by GitHub. |
| Advertising | In addition, GitHub and third parties use advertising cookies to show you new ads based on ads you've already seen. Cookies also track which ads you click or purchases you make after clicking an ad. This is done both for payment purposes and to show you ads that are more relevant to you. For example, cookies are used to detect when you click an ad and to show you ads based on your social media interests and website browsing history. |
#### [What are your cookie choices and controls?](#what-are-your-cookie-choices-and-controls)
You have several options to disable non-essential cookies:
1. **Specifically on GitHub Enterprise Marketing Pages**
Any GitHub page that serves non-essential cookies will have a link in the page’s footer to cookie settings. You can express your preferences at any time by clicking on that linking and updating your settings.
Some users will also be able to manage non-essential cookies via a cookie consent banner, including the options to accept, manage, and reject all non-essential cookies.
2. **Generally for all websites** You can control the cookies you encounter on the web using a variety of widely-available tools. For example:
* If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track)
(DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies.
* Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more.
* If you enable a browser extension designed to block tracking, such as [Privacy Badger](https://en.wikipedia.org/wiki/Privacy_Badger)
, non-essential cookies set by a website or third parties may be disabled.
* If you enable a browser extension designed to block unwanted content, such as [uBlock Origin](https://en.wikipedia.org/wiki/UBlock_Origin)
, non-essential cookies will be disabled to the extent that content that sets non-essential cookies will be blocked.
* You may use the Global Privacy Control (GPC) to communicate your privacy preferences. If GitHub detects the GPC signal from your device, GitHub will not share your data (we do not sell your data). To learn more, visit [Global Privacy Control — Take Control Of Your Privacy](https://globalprivacycontrol.org/)
* Advertising controls. Our advertising partners may participate in associations that provide simple ways to opt out of ad targeting, which you can access at:
* United States: [NAI](http://optout.networkadvertising.org)
and [DAA](http://optout.aboutads.info/)
* Canada: [Digital Advertising Alliance of Canada](https://youradchoices.ca/)
* Europe: [European Digital Advertising Alliance](http://www.youronlinechoices.com/)
These choices are specific to the browser you are using. If you access our Services from other devices or browsers, take these actions from those systems to ensure your choices apply to the data collected when you use those systems.
[US State Specific Information](#us-state-specific-information)
----------------------------------------------------------------
This section provides extra information specifically for residents of certain US states that have distinct data privacy laws and regulations. These laws may grant specific rights to residents of these states when the laws come into effect. This section uses the term “personal information” as an equivalent to the term “Personal Data.”
### [Privacy Rights](#privacy-rights)
These rights are common to the US State privacy laws:
* Right to Knowledge and Correction: You have the right to request details on the specific personal information we’ve collected about you and the right to correct inaccurate information. You can exercise this right by contacting us. You can also access and edit basic account information in your settings.
* Right to Know Data Recipients: We share your information with service providers for legitimate business operations, such as data storage and hosting. For more details, please see “Sharing Your Information” below.
* Right to request Deletion: You reserve the right to request the deletion of your data, barring a few exceptions. Such exceptions include circumstances where we are required to retain data to comply with legal obligations, detect fraudulent activity, investigate reports of abuse or other violations of our Terms of Service, or rectify security issues. Upon receiving your verified request, we will promptly delete your personal information (unless an exception applies), and instruct our service providers to do the same. We employ brief retention terms by design.
* Right to a Timely Response: You are allowed to make two free requests in any 12-month period. We commit to responding to your request within 45 days. In complex cases, we may extend our response time by an additional 45 days.
* Non-Discrimination: We will not hold it against you when you exercise any of your rights. On the contrary, we encourage you to review your privacy settings closely and contact us with any questions.
### [Notice of Collection of Personal Information](#notice-of-collection-of-personal-information)
We may collect various categories of personal information about our website visitors and users of "Services" which includes GitHub applications, software, products, or services. That information includes identifiers/contact information, demographic information, payment information, commercial information, internet or electronic network activity information, geolocation data, audio, electronic, visual, or similar information, and inferences drawn from such information.
We collect this information for various purposes. This includes identifying accessibility gaps and offering targeted support, fostering diversity and representation, providing services, troubleshooting, conducting business operations such as billing and security, improving products and supporting research, communicating important information, ensuring personalized experiences, and promoting safety and security.
### [Exercising your Privacy Rights](#exercising-your-privacy-rights)
To make an access, deletion, correction, or opt-out request, please send an email to privacy\[at\]github\[dot\]com and follow the instructions provided. We may need to verify your identity before processing your request. If you choose to use an authorized agent to submit a request on your behalf, please ensure they have your signed permission or power of attorney as required.
To opt out of the sharing of your personal information, you can click on the "Do Not Share My Personal Information" link on the footer of our Websites or use the Global Privacy Control ("GPC") if available. Authorized agents can also submit opt-out requests on your behalf.
### [California](#california)
#### [Mandatory Disclosures](#mandatory-disclosures)
We also make the following disclosures for purposes of compliance with California privacy law:
* We collected the following categories of personal information in the last 12 months: identifiers/contact information, demographic information (such as gender), payment card information associated with you, commercial information, Internet or other electronic network activity information, geolocation data, audio, electronic, visual or similar information, and inferences drawn from the above.
* The sources of personal information from whom we collected are: directly from you, automatically or from third parties.
* The business or commercial purposes of collecting personal information are as summarized above and in our Privacy Statement under Processing Purposes.
* We disclosed the following categories of personal information for a business purpose in the last 12 months: identifiers/contact information, demographic information (such as gender and rough geographic location), payment information, commercial information, Internet or other electronic network activity information, geolocation data, audio, electronic, visual or similar information, and inferences drawn from the above. We disclosed each category to third-party business partners and service providers, third-party sites or platforms such as social networking sites, and other third parties as described in the Sharing of Personal Data section of our Privacy Statement.
* As defined by applicable law, we “shared” the following categories of personal information in the last 12 months: identifiers/contact information, Internet or other electronic network activity information, and inferences drawn from the above. We shared each category to or with advertising networks, data analytics providers, and social networks.
* The business or commercial purpose of sharing personal information is to assist us with marketing, advertising, and audience measurement.
* We do not “sell” or “share” the personal information of known minors under 16 years of age.
#### [Shine the Light Act](#shine-the-light-act)
Under California Civil Code section 1798.83, also known as the “Shine the Light” law, California residents who have provided personal information to a business with which the individual has established a business relationship for personal, family, or household purposes (“California Customers”) may request information about whether the business has disclosed personal information to any third parties for the third parties’ direct marketing purposes. Please be aware that we do not disclose personal information to any third parties for their direct marketing purposes as defined by this law. California Customers may request further information about our compliance with this law by emailing (privacy\[at\]github\[dot\]com). Please note that businesses are required to respond to one request per California Customer each year and may not be required to respond to requests made by means other than through the designated email address.
#### [Removal of Content](#removal-of-content)
California residents under the age of 18 who are registered users of online sites, services, or applications have a right under California Business and Professions Code Section 22581 to remove, or request and obtain removal of, content or information they have publicly posted. To remove content or information you have publicly posted, please submit a [Private Information Removal request](https://support.github.com/contact/private-information)
. Alternatively, to request that we remove such content or information, please send a detailed description of the specific content or information you wish to have removed to [GitHub support](https://support.github.com/request)
. Please be aware that your request does not guarantee complete or comprehensive removal of content or information posted online and that the law may not permit or require removal in certain circumstances. If you have any questions about our privacy practices with respect to California residents, please send an email to privacy\[at\]github\[dot\]com.
We value the trust you place in us and are committed to handling your personal information with care and respect. If you have any questions or concerns about our privacy practices, please email our Data Protection Officer at dpo\[at\]github\[dot\]com.
### [Colorado/Connecticut/Virginia](#coloradoconnecticutvirginia)
If you live in Colorado, Connecticut, or Virginia you have some additional rights:
* If we deny your rights request, you have the right to appeal that decision. We will provide you with the necessary information to submit an appeal at that time.
* You have the right to opt out of profiling in furtherance of decisions that produce legal or similarly significant effects concerning the consumer. GitHub does not engage in such profiling as defined by Colorado law, so there’s no need to opt out.
### [Nevada](#nevada)
We do not sell your covered information, as defined under Chapter 603A of the Nevada Revised Statutes. If you still have questions about your covered information or anything else in our Privacy Statement, please send an email to privacy\[at\]github\[dot\]com.
---
# GitHub Terms of Service - GitHub Docs
[Skip to main content](#main-content)
GitHub Terms of Service
=======================
In this article
---------------
Thank you for using GitHub! We're happy you're here. Please read this Terms of Service agreement carefully before accessing or using GitHub. Because it is such an important contract between us and our users, we have tried to make it as clear as possible. For your convenience, we have presented these terms in a short non-binding summary followed by the full legal terms.
[Summary](#summary)
--------------------
| Section | What can you find there? |
| --- | --- |
| [A. Definitions](#a-definitions) | Some basic terms, defined in a way that will help you understand this agreement. Refer back up to this section for clarification. |
| [B. Account Terms](#b-account-terms) | These are the basic requirements of having an Account on GitHub. |
| [C. Acceptable Use](#c-acceptable-use) | These are the basic rules you must follow when using your GitHub Account. |
| [D. User-Generated Content](#d-user-generated-content) | You own the content you post on GitHub. However, you have some responsibilities regarding it, and we ask you to grant us some rights so we can provide services to you. |
| [E. Private Repositories](#e-private-repositories) | This section talks about how GitHub will treat content you post in private repositories. |
| [F. Copyright & DMCA Policy](#f-copyright-infringement-and-dmca-policy) | This section talks about how GitHub will respond if you believe someone is infringing your copyrights on GitHub. |
| [G. Intellectual Property Notice](#g-intellectual-property-notice) | This describes GitHub's rights in the website and service. |
| [H. API Terms](#h-api-terms) | These are the rules for using GitHub's APIs, whether you are using the API for development or data collection. |
| [I. Additional Product Terms](#i-github-additional-product-terms) | We have a few specific rules for GitHub's features and products. |
| [J. Beta Previews](#j-beta-previews) | These are some of the additional terms that apply to GitHub's features that are still in development. |
| [K. Payment](#k-payment) | You are responsible for payment. We are responsible for billing you accurately. |
| [L. Cancellation and Termination](#l-cancellation-and-termination) | You may cancel this agreement and close your Account at any time. |
| [M. Communications with GitHub](#m-communications-with-github) | We only use email and other electronic means to stay in touch with our users. We do not provide phone support. |
| [N. Disclaimer of Warranties](#n-disclaimer-of-warranties) | We provide our service as is, and we make no promises or guarantees about this service. **Please read this section carefully; you should understand what to expect.** |
| [O. Limitation of Liability](#o-limitation-of-liability) | We will not be liable for damages or losses arising from your use or inability to use the service or otherwise arising under this agreement. **Please read this section carefully; it limits our obligations to you.** |
| [P. Release and Indemnification](#p-release-and-indemnification) | You are fully responsible for your use of the service. |
| [Q. Changes to these Terms of Service](#q-changes-to-these-terms) | We may modify this agreement, but we will give you 30 days' notice of material changes. |
| [R. Miscellaneous](#r-miscellaneous) | Please see this section for legal details including our choice of law. |
[The GitHub Terms of Service](#the-github-terms-of-service)
------------------------------------------------------------
Effective date: November 16, 2020
[A. Definitions](#a-definitions)
---------------------------------
**Short version:** _We use these basic terms throughout the agreement, and they have specific meanings. You should know what we mean when we use each of the terms. There's not going to be a test on it, but it's still useful information._
1. An "Account" represents your legal relationship with GitHub. A “Personal Account” represents an individual User’s authorization to log in to and use the Service and serves as a User’s identity on GitHub. “Organizations” are shared workspaces that may be associated with a single entity or with one or more Users where multiple Users can collaborate across many projects at once. A Personal Account can be a member of any number of Organizations.
2. The “Agreement” refers, collectively, to all the terms, conditions, notices contained or referenced in this document (the “Terms of Service” or the "Terms") and all other operating rules, policies (including the GitHub Privacy Statement, available at [github.com/site/privacy](https://github.com/site/privacy)
) and procedures that we may publish from time to time on the Website. Most of our site policies are available at [docs.github.com/categories/site-policy](/en/site-policy)
.
3. "Beta Previews" mean software, services, or features identified as alpha, beta, preview, early access, or evaluation, or words or phrases with similar meanings.
4. “Content” refers to content featured or displayed through the Website, including without limitation code, text, data, articles, images, photographs, graphics, software, applications, packages, designs, features, and other materials that are available on the Website or otherwise available through the Service. "Content" also includes Services. “User-Generated Content” is Content, written or otherwise, created or uploaded by our Users. "Your Content" is Content that you create or own.
5. “GitHub,” “We,” and “Us” refer to GitHub, Inc., as well as our affiliates, directors, subsidiaries, contractors, licensors, officers, agents, and employees.
6. The “Service” refers to the applications, software, products, and services provided by GitHub, including any Beta Previews.
7. “The User,” “You,” and “Your” refer to the individual person, company, or organization that has visited or is using the Website or Service; that accesses or uses any part of the Account; or that directs the use of the Account in the performance of its functions. A User must be at least 13 years of age. Special terms may apply for business or government Accounts (See [Section B(5): Additional Terms](#5-additional-terms)
).
8. The “Website” refers to GitHub’s website located at [github.com](https://github.com/)
, and all content, services, and products provided by GitHub at or through the Website. It also refers to GitHub-owned subdomains of github.com, such as [education.github.com](https://education.github.com/)
and [pages.github.com](https://pages.github.com/)
. These Terms also govern GitHub’s conference websites, such as [githubuniverse.com](https://githubuniverse.com/)
, and product websites, such as [electronjs.org](https://www.electronjs.org/)
. Occasionally, websites owned by GitHub may provide different or additional terms of service. If those additional terms conflict with this Agreement, the more specific terms apply to the relevant page or service.
[B. Account Terms](#b-account-terms)
-------------------------------------
**Short version:** _Personal Accounts and Organizations have different administrative controls; a human must create your Account; you must be 13 or over; you must provide a valid email address; and you may not have more than one free Account. You alone are responsible for your Account and anything that happens while you are signed in to or using your Account. You are responsible for keeping your Account secure._
### [1\. Account Controls](#1-account-controls)
* Users. Subject to these Terms, you retain ultimate administrative control over your Personal Account and the Content within it.
* Organizations. The "owner" of an Organization that was created under these Terms has ultimate administrative control over that Organization and the Content within it. Within the Service, an owner can manage User access to the Organization’s data and projects. An Organization may have multiple owners, but there must be at least one Personal Account designated as an owner of an Organization. If you are the owner of an Organization under these Terms, we consider you responsible for the actions that are performed on or through that Organization.
### [2\. Required Information](#2-required-information)
You must provide a valid email address in order to complete the signup process. Any other information requested, such as your real name, is optional, unless you are accepting these terms on behalf of a legal entity (in which case we need more information about the legal entity) or if you opt for a [paid Account](#k-payment)
, in which case additional information will be necessary for billing purposes.
### [3\. Account Requirements](#3-account-requirements)
We have a few simple rules for Personal Accounts on GitHub's Service.
* You must be a human to create an Account. Accounts registered by "bots" or other automated methods are not permitted. We do permit machine accounts:
* A machine account is an Account set up by an individual human who accepts the Terms on behalf of the Account, provides a valid email address, and is responsible for its actions. A machine account is used exclusively for performing automated tasks. Multiple users may direct the actions of a machine account, but the owner of the Account is ultimately responsible for the machine's actions. You may maintain no more than one free machine account in addition to your free Personal Account.
* One person or legal entity may maintain no more than one free Account (if you choose to control a machine account as well, that's fine, but it can only be used for running a machine).
* You must be age 13 or older. While we are thrilled to see brilliant young coders get excited by learning to program, we must comply with United States law. GitHub does not target our Service to children under 13, and we do not permit any Users under 13 on our Service. If we learn of any User under the age of 13, we will [terminate that User’s Account immediately](#l-cancellation-and-termination)
. If you are a resident of a country outside the United States, your country’s minimum age may be older; in such a case, you are responsible for complying with your country’s laws.
* Your login may only be used by one person — i.e., a single login may not be shared by multiple people. A paid Organization may only provide access to as many Personal Accounts as your subscription allows.
* You may not use GitHub in violation of export control or sanctions laws of the United States or any other applicable jurisdiction. You may not use GitHub if you are or are working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx)
or a person subject to similar blocking or denied party prohibitions administered by a U.S. government agency. GitHub may allow persons in certain sanctioned countries or territories to access certain GitHub services pursuant to U.S. government authorizations. For more information, please see our [Export Controls policy](/en/site-policy/other-site-policies/github-and-trade-controls)
.
### [4\. Account Security](#4-account-security)
You are responsible for keeping your Account secure while you use our Service. We offer tools such as two-factor authentication to help you maintain your Account's security, but the content of your Account and its security are up to you.
* You are responsible for all content posted and activity that occurs under your Account (even when content is posted by others who have Accounts under your Account).
* You are responsible for maintaining the security of your Account and password. GitHub cannot and will not be liable for any loss or damage from your failure to comply with this security obligation.
* You will promptly notify GitHub by contacting us through the [GitHub Support portal](https://support.github.com/)
if you become aware of any unauthorized use of, or access to, our Service through your Account, including any unauthorized use of your password or Account.
### [5\. Additional Terms](#5-additional-terms)
In some situations, third parties' terms may apply to your use of GitHub. For example, you may be a member of an organization on GitHub with its own terms or license agreements; you may download an application that integrates with GitHub; or you may use GitHub to authenticate to another service. Please be aware that while these Terms are our full agreement with you, other parties' terms govern their relationships with you.
If you are a government User or otherwise accessing or using any GitHub Service in a government capacity, this [Government Amendment to GitHub Terms of Service](/en/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users)
applies to you, and you agree to its provisions.
If you have signed up for GitHub Enterprise Cloud, the [Enterprise Cloud Addendum](/en/site-policy/site-policy-deprecated/github-enterprise-service-level-agreement)
applies to you, and you agree to its provisions.
[C. Acceptable Use](#c-acceptable-use)
---------------------------------------
**Short version:** _GitHub hosts a wide variety of collaborative projects from all over the world, and that collaboration only works when our users are able to work together in good faith. While using the service, you must follow the terms of this section, which include some restrictions on content you can post, conduct on the service, and other limitations. In short, be excellent to each other._
Your use of the Website and Service must not violate any applicable laws, including copyright or trademark laws, export control or sanctions laws, or other laws in your jurisdiction. You are responsible for making sure that your use of the Service is in compliance with laws and any applicable regulations.
You agree that you will not under any circumstances violate our [Acceptable Use Policies](/en/site-policy/acceptable-use-policies/github-acceptable-use-policies)
or [Community Guidelines](/en/site-policy/github-terms/github-community-guidelines)
.
[D. User-Generated Content](#d-user-generated-content)
-------------------------------------------------------
**Short version:** _You own content you create, but you allow us certain rights to it, so that we can display and share the content you post. You still have control over your content, and responsibility for it, and the rights you grant us are limited to those we need to provide the service. We have the right to remove content or close Accounts if we need to._
### [1\. Responsibility for User-Generated Content](#1-responsibility-for-user-generated-content)
You may create or upload User-Generated Content while using the Service. You are solely responsible for the content of, and for any harm resulting from, any User-Generated Content that you post, upload, link to or otherwise make available via the Service, regardless of the form of that Content. We are not responsible for any public display or misuse of your User-Generated Content.
### [2\. GitHub May Remove Content](#2-github-may-remove-content)
We have the right to refuse or remove any User-Generated Content that, in our sole discretion, violates any laws or [GitHub terms or policies](/en/site-policy)
. User-Generated Content displayed on GitHub Mobile may be subject to mobile app stores' additional terms.
### [3\. Ownership of Content, Right to Post, and License Grants](#3-ownership-of-content-right-to-post-and-license-grants)
You retain ownership of and responsibility for Your Content. If you're posting anything you did not create yourself or do not own the rights to, you agree that you are responsible for any Content you post; that you will only submit Content that you have the right to post; and that you will fully comply with any third party licenses relating to Content you post.
Because you retain ownership of and responsibility for Your Content, we need you to grant us — and other GitHub Users — certain legal permissions, listed in Sections D.4 — D.7. These license grants apply to Your Content. If you upload Content that already comes with a license granting GitHub the permissions we need to run our Service, no additional license is required. You understand that you will not receive any payment for any of the rights granted in Sections D.4 — D.7. The licenses you grant to us will end when you remove Your Content from our servers, unless other Users have forked it.
### [4\. License Grant to Us](#4-license-grant-to-us)
We need the legal right to do things like host Your Content, publish it, and share it. You grant us and our legal successors the right to store, archive, parse, and display Your Content, and make incidental copies, as necessary to provide the Service, including improving the Service over time. This license includes the right to do things like copy it to our database and make backups; show it to you and other users; parse it into a search index or otherwise analyze it on our servers; share it with other users; and perform it, in case Your Content is something like music or video.
This license does not grant GitHub the right to sell Your Content. It also does not grant GitHub the right to otherwise distribute or use Your Content outside of our provision of the Service, except that as part of the right to archive Your Content, GitHub may permit our partners to store and archive Your Content in public repositories in connection with the [GitHub Arctic Code Vault and GitHub Archive Program](https://archiveprogram.github.com/)
.
### [5\. License Grant to Other Users](#5-license-grant-to-other-users)
Any User-Generated Content you post publicly, including issues, comments, and contributions to other Users' repositories, may be viewed by others. By setting your repositories to be viewed publicly, you agree to allow others to view and "fork" your repositories (this means that others may make their own copies of Content from your repositories in repositories they control).
If you set your pages and repositories to be viewed publicly, you grant each User of GitHub a nonexclusive, worldwide license to use, display, and perform Your Content through the GitHub Service and to reproduce Your Content solely on GitHub as permitted through GitHub's functionality (for example, through forking). You may grant further rights if you [adopt a license](/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository#including-an-open-source-license-in-your-repository)
. If you are uploading Content you did not create or own, you are responsible for ensuring that the Content you upload is licensed under terms that grant these permissions to other GitHub Users.
### [6\. Contributions Under Repository License](#6-contributions-under-repository-license)
Whenever you add Content to a repository containing notice of a license, you license that Content under the same terms, and you agree that you have the right to license that Content under those terms. If you have a separate agreement to license that Content under different terms, such as a contributor license agreement, that agreement will supersede.
Isn't this just how it works already? Yep. This is widely accepted as the norm in the open-source community; it's commonly referred to by the shorthand "inbound=outbound". We're just making it explicit.
### [7\. Moral Rights](#7-moral-rights)
You retain all moral rights to Your Content that you upload, publish, or submit to any part of the Service, including the rights of integrity and attribution. However, you waive these rights and agree not to assert them against us, to enable us to reasonably exercise the rights granted in Section D.4, but not otherwise.
To the extent this agreement is not enforceable by applicable law, you grant GitHub the rights we need to use Your Content without attribution and to make reasonable adaptations of Your Content as necessary to render the Website and provide the Service.
[E. Private Repositories](#e-private-repositories)
---------------------------------------------------
**Short version:** _We treat the content of private repositories as confidential, and we only access it as described in our Privacy Statement—for security purposes, to assist the repository owner with a support matter, to maintain the integrity of the Service, to comply with our legal obligations, if we have reason to believe the contents are in violation of the law, or with your consent._
### [1\. Control of Private Repositories](#1-control-of-private-repositories)
Some Accounts may have private repositories, which allow the User to control access to Content.
### [2\. Confidentiality of Private Repositories](#2-confidentiality-of-private-repositories)
GitHub considers the contents of private repositories to be confidential to you. GitHub will protect the contents of private repositories from unauthorized use, access, or disclosure in the same manner that we would use to protect our own confidential information of a similar nature and in no event with less than a reasonable degree of care.
### [3\. Access](#3-access)
GitHub personnel may only access the content of your private repositories in the situations described in our [Privacy Statement](/en/site-policy/privacy-policies/github-privacy-statement#repository-contents)
.
You may choose to enable additional access to your private repositories. For example:
* You may enable various GitHub services or features that require additional rights to Your Content in private repositories. These rights may vary depending on the service or feature, but GitHub will continue to treat your private repository Content as confidential. If those services or features require rights in addition to those we need to provide the GitHub Service, we will provide an explanation of those rights.
Additionally, we may be [compelled by law](/en/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure)
to disclose the contents of your private repositories.
GitHub will provide notice regarding our access to private repository content, unless [for legal disclosure](/en/site-policy/privacy-policies/github-privacy-statement#for-legal-disclosure)
, to comply with our legal obligations, or where otherwise bound by requirements under law, for automated scanning, or if in response to a security threat or other risk to security.
[F. Copyright Infringement and DMCA Policy](#f-copyright-infringement-and-dmca-policy)
---------------------------------------------------------------------------------------
If you believe that content on our website violates your copyright, please contact us in accordance with our [Digital Millennium Copyright Act Policy](/en/site-policy/content-removal-policies/dmca-takedown-policy)
. If you are a copyright owner and you believe that content on GitHub violates your rights, please contact us via [our convenient DMCA form](https://github.com/contact/dmca)
or by emailing [copyright@github.com](mailto:copyright@github.com)
. There may be legal consequences for sending a false or frivolous takedown notice. Before sending a takedown request, you must consider legal uses such as fair use and licensed uses.
We will terminate the Accounts of [repeat infringers](/en/site-policy/content-removal-policies/dmca-takedown-policy#e-repeated-infringement)
of this policy.
[G. Intellectual Property Notice](#g-intellectual-property-notice)
-------------------------------------------------------------------
**Short version:** _We own the service and all of our content. In order for you to use our content, we give you certain rights to it, but you may only use our content in the way we have allowed._
### [1\. GitHub's Rights to Content](#1-githubs-rights-to-content)
GitHub and our licensors, vendors, agents, and/or our content providers retain ownership of all intellectual property rights of any kind related to the Website and Service. We reserve all rights that are not expressly granted to you under this Agreement or by law. The look and feel of the Website and Service is copyright © GitHub, Inc. All rights reserved. You may not duplicate, copy, or reuse any portion of the HTML/CSS, JavaScript, or visual design elements or concepts without express written permission from GitHub.
### [2\. GitHub Trademarks and Logos](#2-github-trademarks-and-logos)
If you’d like to use GitHub’s trademarks, you must follow all of our trademark guidelines, including those on our logos page: [https://github.com/logos](https://github.com/logos)
.
### [3\. License to GitHub Policies](#3-license-to-github-policies)
This Agreement is licensed under this [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/)
. For details, see our [site-policy repository](https://github.com/github/site-policy#license)
.
[H. API Terms](#h-api-terms)
-----------------------------
**Short version:** _You agree to these Terms of Service, plus this Section H, when using any of GitHub's APIs (Application Provider Interface), including use of the API through a third party product that accesses GitHub._
Abuse or excessively frequent requests to GitHub via the API may result in the temporary or permanent suspension of your Account's access to the API. GitHub, in our sole discretion, will determine abuse or excessive usage of the API. We will make a reasonable attempt to warn you via email prior to suspension.
You may not share API tokens to exceed GitHub's rate limitations.
You may not use the API to download data or Content from GitHub for spamming purposes, including for the purposes of selling GitHub users' personal information, such as to recruiters, headhunters, and job boards.
All use of the GitHub API is subject to these Terms of Service and the [GitHub Privacy Statement](https://github.com/site/privacy)
.
GitHub may offer subscription-based access to our API for those Users who require high-throughput access or access that would result in resale of GitHub's Service.
[I. GitHub Additional Product Terms](#i-github-additional-product-terms)
-------------------------------------------------------------------------
**Short version:** _You need to follow certain specific terms and conditions for GitHub's various features and products, and you agree to the Supplemental Terms and Conditions when you agree to this Agreement._
Some Service features may be subject to additional terms specific to that feature or product as set forth in the GitHub Additional Product Terms. By accessing or using the Services, you also agree to the [GitHub Additional Product Terms](/en/site-policy/github-terms/github-terms-for-additional-products-and-features)
.
[J. Beta Previews](#j-beta-previews)
-------------------------------------
**Short version:** _Beta Previews may not be supported or may change at any time. You may receive confidential information through those programs that must remain confidential while the program is private. We'd love your feedback to make our Beta Previews better._
### [1\. Subject to Change](#1-subject-to-change)
Beta Previews may not be supported and may be changed at any time without notice. In addition, Beta Previews are not subject to the same security measures and auditing to which the Service has been and is subject. **By using a Beta Preview, you use it at your own risk.**
### [2\. Confidentiality](#2-confidentiality)
As a user of Beta Previews, you may get access to special information that isn’t available to the rest of the world. Due to the sensitive nature of this information, it’s important for us to make sure that you keep that information secret.
**Confidentiality Obligations.** You agree that any non-public Beta Preview information we give you, such as information about a private Beta Preview, will be considered GitHub’s confidential information (collectively, “Confidential Information”), regardless of whether it is marked or identified as such. You agree to only use such Confidential Information for the express purpose of testing and evaluating the Beta Preview (the “Purpose”), and not for any other purpose. You should use the same degree of care as you would with your own confidential information, but no less than reasonable precautions to prevent any unauthorized use, disclosure, publication, or dissemination of our Confidential Information. You promise not to disclose, publish, or disseminate any Confidential Information to any third party, unless we don’t otherwise prohibit or restrict such disclosure (for example, you might be part of a GitHub-organized group discussion about a private Beta Preview feature).
**Exceptions.** Confidential Information will not include information that is: (a) or becomes publicly available without breach of this Agreement through no act or inaction on your part (such as when a private Beta Preview becomes a public Beta Preview); (b) known to you before we disclose it to you; (c) independently developed by you without breach of any confidentiality obligation to us or any third party; or (d) disclosed with permission from GitHub. You will not violate the terms of this Agreement if you are required to disclose Confidential Information pursuant to operation of law, provided GitHub has been given reasonable advance written notice to object, unless prohibited by law.
### [3\. Feedback](#3-feedback)
We’re always trying to improve of products and services, and your feedback as a Beta Preview user will help us do that. If you choose to give us any ideas, know-how, algorithms, code contributions, suggestions, enhancement requests, recommendations or any other feedback for our products or services (collectively, “Feedback”), you acknowledge and agree that GitHub will have a royalty-free, fully paid-up, worldwide, transferable, sub-licensable, irrevocable and perpetual license to implement, use, modify, commercially exploit and/or incorporate the Feedback into our products, services, and documentation.
[K. Payment](#k-payment)
-------------------------
**Short version:** _You are responsible for any fees associated with your use of GitHub. We are responsible for communicating those fees to you clearly and accurately, and letting you know well in advance if those prices change._
### [1\. Pricing](#1-pricing)
Our pricing and payment terms are available at [github.com/pricing](https://github.com/pricing)
. If you agree to a subscription price, that will remain your price for the duration of the payment term; however, prices are subject to change at the end of a payment term.
### [2\. Upgrades, Downgrades, and Changes](#2-upgrades-downgrades-and-changes)
* We will immediately bill you when you upgrade from the free plan to any paying plan.
* If you change from a monthly billing plan to a yearly billing plan, GitHub will bill you for a full year at the next monthly billing date.
* If you upgrade to a higher level of service, we will bill you for the upgraded plan immediately.
* You may change your level of service at any time by [choosing a plan option](https://github.com/pricing)
or going into your [Billing settings](https://github.com/settings/billing)
. If you choose to downgrade your Account, you may lose access to Content, features, or capacity of your Account. Please see our section on [Cancellation](#l-cancellation-and-termination)
for information on getting a copy of that Content.
### [3\. Billing Schedule; No Refunds](#3-billing-schedule-no-refunds)
**Payment Based on Plan** For monthly or yearly payment plans, the Service is billed in advance on a monthly or yearly basis respectively and is non-refundable. There will be no refunds or credits for partial months of service, downgrade refunds, or refunds for months unused with an open Account; however, the service will remain active for the length of the paid billing period. In order to treat everyone equally, no exceptions will be made.
**Payment Based on Usage** Some Service features are billed based on your usage. A limited quantity of these Service features may be included in your plan for a limited term without additional charge. If you choose to use paid Service features beyond the quantity included in your plan, you pay for those Service features based on your actual usage in the preceding month. Monthly payment for these purchases will be charged on a periodic basis in arrears. See [GitHub Additional Product Terms for Details](/en/site-policy/github-terms/github-terms-for-additional-products-and-features)
.
**Invoicing** For invoiced Users, User agrees to pay the fees in full, up front without deduction or setoff of any kind, in U.S. Dollars. User must pay the fees within thirty (30) days of the GitHub invoice date. Amounts payable under this Agreement are non-refundable, except as otherwise provided in this Agreement. If User fails to pay any fees on time, GitHub reserves the right, in addition to taking any other action at law or equity, to (i) charge interest on past due amounts at 1.0% per month or the highest interest rate allowed by law, whichever is less, and to charge all expenses of recovery, and (ii) terminate the applicable order form. User is solely responsible for all taxes, fees, duties and governmental assessments (except for taxes based on GitHub's net income) that are imposed or become due in connection with this Agreement.
### [4\. Authorization](#4-authorization)
By agreeing to these Terms, you are giving us permission to charge your on-file credit card, PayPal account, or other approved methods of payment for fees that you authorize for GitHub.
### [5\. Responsibility for Payment](#5-responsibility-for-payment)
You are responsible for all fees, including taxes, associated with your use of the Service. By using the Service, you agree to pay GitHub any charge incurred in connection with your use of the Service. If you dispute the matter, contact us through the [GitHub Support portal](https://support.github.com/)
. You are responsible for providing us with a valid means of payment for paid Accounts. Free Accounts are not required to provide payment information.
[L. Cancellation and Termination](#l-cancellation-and-termination)
-------------------------------------------------------------------
**Short version:** _You may close your Account at any time. If you do, we'll treat your information responsibly._
### [1\. Account Cancellation](#1-account-cancellation)
It is your responsibility to properly cancel your Account with GitHub. You can [cancel your Account at any time](/en/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)
by going into your Settings in the global navigation bar at the top of the screen. The Account screen provides a simple, no questions asked cancellation link. We are not able to cancel Accounts in response to an email or phone request.
### [2\. Upon Cancellation](#2-upon-cancellation)
We will retain and use your information as necessary to comply with our legal obligations, resolve disputes, and enforce our agreements, but barring legal requirements, we will delete your full profile and the Content of your repositories within 90 days of cancellation or termination (though some information may remain in encrypted backups). This information cannot be recovered once your Account is canceled.
We will not delete Content that you have contributed to other Users' repositories or that other Users have forked.
Upon request, we will make a reasonable effort to provide an Account owner with a copy of your lawful, non-infringing Account contents after Account cancellation, termination, or downgrade. You must make this request within 90 days of cancellation, termination, or downgrade.
### [3\. GitHub May Terminate](#3-github-may-terminate)
GitHub has the right to suspend or terminate your access to all or any part of the Website at any time, with or without cause, with or without notice, effective immediately. GitHub reserves the right to refuse service to anyone for any reason at any time.
### [4\. Survival](#4-survival)
All provisions of this Agreement which, by their nature, should survive termination _will_ survive termination — including, without limitation: ownership provisions, warranty disclaimers, indemnity, and limitations of liability.
[M. Communications with GitHub](#m-communications-with-github)
---------------------------------------------------------------
**Short version:** _We use email and other electronic means to stay in touch with our users._
### [1\. Electronic Communication Required](#1-electronic-communication-required)
For contractual purposes, you (1) consent to receive communications from us in an electronic form via the email address you have submitted or via the Service; and (2) agree that all Terms of Service, agreements, notices, disclosures, and other communications that we provide to you electronically satisfy any legal requirement that those communications would satisfy if they were on paper. This section does not affect your non-waivable rights.
### [2\. Legal Notice to GitHub Must Be in Writing](#2-legal-notice-to-github-must-be-in-writing)
Communications made through email or GitHub Support's messaging system will not constitute legal notice to GitHub or any of its officers, employees, agents or representatives in any situation where notice to GitHub is required by contract or any law or regulation. Legal notice to GitHub must be in writing and [served on GitHub's legal agent](/en/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data#submitting-requests)
.
### [3\. No Phone Support](#3-no-phone-support)
GitHub only offers support via email, in-Service communications, and electronic messages. We do not offer telephone support.
[N. Disclaimer of Warranties](#n-disclaimer-of-warranties)
-----------------------------------------------------------
**Short version:** _We provide our service as is, and we make no promises or guarantees about this service. Please read this section carefully; you should understand what to expect._
GitHub provides the Website and the Service “as is” and “as available,” without warranty of any kind. Without limiting this, we expressly disclaim all warranties, whether express, implied or statutory, regarding the Website and the Service including without limitation any warranty of merchantability, fitness for a particular purpose, title, security, accuracy and non-infringement.
GitHub does not warrant that the Service will meet your requirements; that the Service will be uninterrupted, timely, secure, or error-free; that the information provided through the Service is accurate, reliable or correct; that any defects or errors will be corrected; that the Service will be available at any particular time or location; or that the Service is free of viruses or other harmful components. You assume full responsibility and risk of loss resulting from your downloading and/or use of files, information, content or other material obtained from the Service.
[O. Limitation of Liability](#o-limitation-of-liability)
---------------------------------------------------------
**Short version:** _We will not be liable for damages or losses arising from your use or inability to use the service or otherwise arising under this agreement. Please read this section carefully; it limits our obligations to you._
You understand and agree that we will not be liable to you or any third party for any loss of profits, use, goodwill, or data, or for any incidental, indirect, special, consequential or exemplary damages, however arising, that result from
* the use, disclosure, or display of your User-Generated Content;
* your use or inability to use the Service;
* any modification, price change, suspension or discontinuance of the Service;
* the Service generally or the software or systems that make the Service available;
* unauthorized access to or alterations of your transmissions or data;
* statements or conduct of any third party on the Service;
* any other user interactions that you input or receive through your use of the Service; or
* any other matter relating to the Service.
Our liability is limited whether or not we have been informed of the possibility of such damages, and even if a remedy set forth in this Agreement is found to have failed of its essential purpose. We will have no liability for any failure or delay due to matters beyond our reasonable control.
[P. Release and Indemnification](#p-release-and-indemnification)
-----------------------------------------------------------------
**Short version:** _You are responsible for your use of the service. If you harm someone else or get into a dispute with someone else, we will not be involved._
If you have a dispute with one or more Users, you agree to release GitHub from any and all claims, demands and damages (actual and consequential) of every kind and nature, known and unknown, arising out of or in any way connected with such disputes.
You agree to indemnify us, defend us, and hold us harmless from and against any and all claims, liabilities, and expenses, including attorneys’ fees, arising out of your use of the Website and the Service, including but not limited to your violation of this Agreement, provided that GitHub (1) promptly gives you written notice of the claim, demand, suit or proceeding; (2) gives you sole control of the defense and settlement of the claim, demand, suit or proceeding (provided that you may not settle any claim, demand, suit or proceeding unless the settlement unconditionally releases GitHub of all liability); and (3) provides to you all reasonable assistance, at your expense.
[Q. Changes to These Terms](#q-changes-to-these-terms)
-------------------------------------------------------
**Short version:** _We want our users to be informed of important changes to our terms, but some changes aren't that important — we don't want to bother you every time we fix a typo. So while we may modify this agreement at any time, we will notify users of any material changes and give you time to adjust to them._
We reserve the right, at our sole discretion, to amend these Terms of Service at any time and will update these Terms of Service in the event of any such amendments. We will notify our Users of material changes to this Agreement, such as price increases, at least 30 days prior to the change taking effect by posting a notice on our Website or sending email to the primary email address specified in your GitHub account. Customer's continued use of the Service after those 30 days constitutes agreement to those revisions of this Agreement. For any other modifications, your continued use of the Website constitutes agreement to our revisions of these Terms of Service. You can view all changes to these Terms in our [Site Policy](https://github.com/github/site-policy)
repository.
We reserve the right at any time and from time to time to modify or discontinue, temporarily or permanently, the Website (or any part of it) with or without notice.
[R. Miscellaneous](#r-miscellaneous)
-------------------------------------
### [1\. Governing Law](#1-governing-law)
Except to the extent applicable law provides otherwise, this Agreement between you and GitHub and any access to or use of the Website or the Service are governed by the federal laws of the United States of America and the laws of the State of California, without regard to conflict of law provisions. You and GitHub agree to submit to the exclusive jurisdiction and venue of the courts located in the City and County of San Francisco, California.
### [2\. Non-Assignability](#2-non-assignability)
GitHub may assign or delegate these Terms of Service and/or the [GitHub Privacy Statement](https://github.com/site/privacy)
, in whole or in part, to any person or entity at any time with or without your consent, including the license grant in Section D.4. You may not assign or delegate any rights or obligations under the Terms of Service or Privacy Statement without our prior written consent, and any unauthorized assignment and delegation by you is void.
### [3\. Section Headings and Summaries](#3-section-headings-and-summaries)
Throughout this Agreement, each section includes titles and brief summaries of the following terms and conditions. These section titles and brief summaries are not legally binding.
### [4\. Severability, No Waiver, and Survival](#4-severability-no-waiver-and-survival)
If any part of this Agreement is held invalid or unenforceable, that portion of the Agreement will be construed to reflect the parties’ original intent. The remaining portions will remain in full force and effect. Any failure on the part of GitHub to enforce any provision of this Agreement will not be considered a waiver of our right to enforce such provision. Our rights under this Agreement will survive any termination of this Agreement.
### [5\. Amendments; Complete Agreement](#5-amendments-complete-agreement)
This Agreement may only be modified by a written amendment signed by an authorized representative of GitHub, or by the posting by GitHub of a revised version in accordance with [Section Q. Changes to These Terms](#q-changes-to-these-terms)
. These Terms of Service, together with the GitHub Privacy Statement, represent the complete and exclusive statement of the agreement between you and us. This Agreement supersedes any proposal or prior agreement oral or written, and any other communications between you and GitHub relating to the subject matter of these terms including any confidentiality or nondisclosure agreements.
### [6\. Questions](#6-questions)
Questions about the Terms of Service? Contact us through the [GitHub Support portal](https://support.github.com/)
.
---
# GitHub Actions · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-features-actions)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub Actions
Automate your workflow from idea to production
==============================================
GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management, and issue triaging work the way you want.
[Get started](https://docs.github.com/actions)
[Contact sales](/enterprise/contact?ref_cta=Contact+Sales&ref_loc=hero&ref_page=%2Ffeatures%2Factions&scid=&utm_campaign=Actions_feature_page_contact_sales_cta_utmroutercampaign&utm_content=Actions&utm_medium=site&utm_source=github)
### Hosted runners for every major OS
Linux, macOS, Windows, ARM, GPU, and containers make it easy to build and test all your projects. Run directly on a VM or inside a container. Use your own VMs, in the cloud or on-prem, with self-hosted runners.
### Matrix builds
Save time with matrix workflows that simultaneously test across multiple operating systems and versions of your runtime.
### Any language
GitHub Actions supports Node.js, Python, Java, Ruby, PHP, Go, Rust, .NET, and more. Build, test, and deploy applications in your language of choice.
### Live logs
See your workflow run in realtime with color and emoji. It’s one click to copy a link that highlights a specific line number to share a CI/CD failure.
### Built in secret store
Automate your software development practices with workflow files embracing the Git flow by codifying it in your repository.
### Multi-container testing
Test your web service and its DB in your workflow by simply adding some docker-compose to your workflow file.
Run a workflow on
any GitHub event
------------------------------------
Whether you want to build a container, deploy a web service, or automate welcoming new users to your open source projects—thereʼs an action for that. Pair GitHub Packages with Actions to simplify package management, including version updates, fast distribution with our global CDN, and dependency resolution, using your existing GITHUB\_TOKEN.
### Actions marketplace
_GitHub Actions connects all of your tools_ to automate every step of your development workflow.
[Explore the actions marketplace](https://github.com/marketplace?type=actions)
* _Easily deploy to any cloud, create tickets in Jira, or publish a package to npm._
* _Want to venture off the beaten path?_ Use the millions of open source libraries available on GitHub to create your own actions. Write them in JavaScript or create a container action—both can interact with the full GitHub API and any other public API.
Secure Package Registry for Code and Workflows
----------------------------------------------
Securely store and manage your code and packages with GitHub credentials, integrated into your workflows via APIs and webhooks. Enjoy fast, reliable downloads through a global CDN for optimized performance.
[Read the docs](https://docs.github.com/packages)
“
> Actions is an exciting development and unlocks so much potential beyond CI/CD. It promises to streamline our workflows for a variety of tasks, from deploying our websites to querying the GitHub API for custom status reports to standard CI builds.
Ralf GommersSciPy maintainer
### [GitHub Actions is free for public repositories](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-actions/about-billing-for-github-actions#included-storage-and-minutes)
Our open source commitment means you get free CI/CD minutes on GitHub-hosted runners, tailored to every plan for public repositories.
Learn about storage and minutes
### [Host your own runners or use GitHub-hosted runners](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)
Run your Actions workflows with your own self-hosted runners or use GitHub-hosted runners. Choose from Linux, Windows, or macOS, and customize with more cores, ARM, or GPU options for enhanced performance. View pricing and the different runner types on our docs.
View pricing
### The future of workflow automation is now
Get started with GitHub Actions today and explore community created
actions in the GitHub Marketplace.
[Get started](https://docs.github.com/actions)
[Contact sales](/enterprise/contact?ref_cta=Contact+Sales&ref_loc=cta-banner&ref_page=%2Ffeatures%2Factions&scid=&utm_campaign=Actions_feature_page_contact_sales_cta_utmroutercampaign&utm_content=Actions&utm_medium=site&utm_source=github)
You can’t perform that action at this time.
---
# GitHub Code Review · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-features-code-review)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Code Review
Write better code
=================
On GitHub, lightweight code review tools are built into every pull request. Your team can create review processes that improve the quality of your code and fit neatly into your workflow.
[Get started](/pricing)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=hero&ref_page=%2Ffeatures%2Fcode-review&utm_content=Platform&utm_medium=site&utm_source=github)
_Every change starts with a pull request._
[Learn pull request fundamentals](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
* _Start a new feature or propose a change to existing code with a pull request_—a base for your team to coordinate details and refine your changes.
* _Pull requests are fundamental to how teams review and improve code on GitHub_. Evolve projects, propose new features, and discuss implementation details before changing your source code.
### Diffs
Preview changes in context with your code to see what is being proposed. Side-by-side Diffs highlight added, edited, and deleted code right next to the original file, so you can easily spot changes.
[Learn more](https://docs.github.com/articles/about-comparing-branches-in-pull-requests/)
### History
Browse commits, comments, and references related to your pull request in a timeline-style interface. Your pull request will also highlight what’s changed since you last checked.
[Learn more](https://docs.github.com/articles/searching-commits/)
### Blame
See what a file looked like before a particular change. With blame view, you can see how any portion of your file has evolved over time without viewing the file’s full history.
[Learn more](https://docs.github.com/articles/tracing-changes-in-a-file/)
### Comments
On GitHub, conversations happen alongside your code. Leave detailed comments on code syntax and ask questions about structure inline.
### Review requests
If you’re on the other side of the code, requesting peer reviews is easy. Add users to your pull request, and they’ll receive a notification letting them know you need their feedback.
### Reviews
Save your teammates a few notifications. Bundle your comments into one cohesive review, then specify whether comments are required changes or just suggestions.
### Resolve simple conflicts
You can’t always avoid conflict. Merge pull requests faster by resolving simple merge conflicts on GitHub—no command line necessary.
[Learn how to resolve merge conflicts](https://docs.github.com/articles/resolving-a-merge-conflict-on-github/)
### [Fast, relevant results](https://github.com/pricing)
Give collaborators as much access as they need through your repository settings. You can extend access to a few teams and select which ones can read or write to your files. The options you have for permissions depend on your plan.
See plan options
### [Protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)
Protected Branches help you maintain the integrity of your code. Limit who can push to a branch, and disable force pushes to specific branches. Then scale your policies with the Protected Branches API.
Learn more
### [Required status checks](https://docs.github.com/rest/commits/statuses)
Create required status checks to add an extra layer of error prevention on branches. Use the Status API to enforce checks and disable the merge button until they pass. To err is human; to automate, divine!
Status API doc
### Every change starts with a pull request.
[Get started](/pricing)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=cta-banner&ref_page=%2Ffeatures%2Fcode-review&utm_content=Platform&utm_medium=site&utm_source=github)
You can’t perform that action at this time.
---
# GitHub Issues · Project planning for developers · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-features-issues)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub Issues
Project planning
for developers
=================================
Create issues, break them into tasks, track relationships, add custom fields, and have conversations. Visualize large projects as tables, boards, or roadmaps, and automate everything with code.
[Get started](https://docs.github.com/issues)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=hero&ref_page=%2Ffeatures%2Fissues&utm_content=Platform&utm_medium=site&utm_source=github)
Featured logos
--------------
### Break issues into
actionable tasks
Tackle complex issues with task lists and track their status with new progress indicators. Convert tasks into their own issues and navigate your work hierarchy.
### Move conversations forward
Express ideas with GitHub Flavored Markdown, mention contributors, react with emoji, clarify with attachments, and see references from commits, pull requests, releases, and deploys. Coordinate by assigning contributors and teams, or by adding them to milestones and projects. All in a single timeline.
* Upload and attach videos to comments
* Dive into work faster with issue forms and templates
Features
--------
_Bored of boards?_ Switch to tables and roadmaps. Create views for how you work.
* _Save views for sprints, backlogs, teams, or releases._Rank, group, sort, slice and filter to suit the occasion. Create swimlanes, share templates and set work in progress limits.
* _No mouse? No problem._ Every action you can take with the mouse has a keyboard shortcut or command. Filter, sort, group, and assign issues. Your hands never leave the keyboard.
### Extend issues with
custom fields
Track metadata like iterations, priority, story points, dates, notes, and links. Add custom fields to projects and edit from the issue sidebar.
### Track progress with
project insights
Track the health of your current iteration cycle, milestone, or any other custom field you create with new project insights. Identify bottlenecks and issues blocking the team from making progress with the new burn up chart.
### Share best practices with
project templates
Create templates to share and reuse when getting started with a new project. Share inspiration across teams and get started with a single click.
### Manage work automatically
Accelerate your project planning with workflows. Automatically triage issues, set values for custom fields, and auto add or archive issues.
### [GitHub CLI](https://cli.github.com)
View, update, and create issues without ever leaving your terminal.
Learn more
### [GitHub Mobile](https://github.com/mobile)
Create and manage issues on the go with our native iOS and Android mobile apps.
Learn more
“
> The new planning and tracking functionality keeps my project management close to my code. I no longer find myself needing to reach for spreadsheets or 3P tools which go stale instantly.
Dan GodfreyDevelopment Manager
### Flexible project planning for developers
[Get started](https://docs.github.com/issues)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=cta-banner&ref_page=%2Ffeatures%2Fissues&utm_content=Platform&utm_medium=site&utm_source=github)
### Frequently asked questions
#### What is GitHub Issues?
We all need a way to plan our work, track issues, and discuss the things we build. Our answer to this universal question is GitHub Issues, and it’s built-in to every repository. GitHub’s issue tracking is unique because of our focus on simplicity, references, and elegant formatting.
With GitHub Issues, you can express ideas with GitHub Flavored Markdown, assign and mention contributors, react with emojis, clarify with attachments and videos, plus reference code like commits, pull requests, and deploys. With task lists, you can break big issues into tasks, further organize your work with milestones and labels, and track relationships and dependencies.
We built GitHub Issues for developers. It is simple, adaptable, and powerful.
#### What are Projects?
As teams and projects grow, how we work evolves. Tools that hard-code a methodology are too specific and rigid to adapt to any moment. Often, we find ourselves creating a spreadsheet or pulling out a notepad to have the space to think. Then our planning is disconnected from where the work happens.
The new Projects connect your planning directly to the work your teams are doing and flexibly adapt to whatever your team needs at any point. Built like a spreadsheet, project tables give you a live canvas to filter, sort, and group issues and pull requests. You can use it, or the accompanying project board, along with custom fields, to track a sprint, plan a feature, or manage a large-scale release.
#### Can I update existing Projects to use the new capabilities?
Yes. You can migrate your existing Projects (classic) to the new GitHub Projects through a new feature preview.
How it works:
* We’ll create a new project and copy all of the data from your existing project (classic) board to the new one.
* Once the data is copied, you can use the new project with all the new capabilities.
* Once the new project is ready, we will prompt you to close your “old” project, as the old project is not kept in sync.
#### What plans have access to Projects?
All users have access to the free tier of GitHub Issues and Projects. For more information about paid tiers, see our pricing page.
Historical charts are available for all Enterprise organizations and are currently in Preview for organizations on Team plans.\*\*
\*\*Subject to change as we add future capabilities.
#### Will the new Projects experience be available in GitHub Enterprise Server?
Yes! GitHub Enterprise Server (GHES) support follows our regular cadence of one to two quarters before enabling the on-premises functionality.
You can’t perform that action at this time.
---
# GitHub Codespaces · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-features-codespaces)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub Codespaces
Secure development made simple
==============================
GitHub Codespaces gets you up and coding faster with fully configured, secure cloud development environments native to GitHub.
[Get started](/codespaces)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=cta-banner&ref_page=%2Ffeatures%2Fcodespaces&utm_content=Platform&utm_medium=site&utm_source=github)
Secure by design
----------------
Created with security in mind, Codespaces provides a secure development environment through its built-in capabilities and native integration with the GitHub platform.
Collaborate where you code
--------------------------
Codespaces provides a shared development environment and removes the need for complex setups.
### Customize your Codespaces
_Your space, your way._ Codespaces is a home away from home for your code that feels just like your usual machine.
* _Start coding instantly from anywhere in the world._ Switching projects? Grab a new machine from the cloud that’s preconfigured for that project. Your settings travel with you.
* _Tabs or spaces? Monokai or Solarized? Prettier or Beautify? It’s up to you._ Control every nerdy detail only you care about with your own dotfiles repository.
Browser preview and port forwarding
-----------------------------------
Preview your changes and get feedback from teammates by sharing ports within the scope allowed by policy.
Onboard faster
--------------
Quickly spin up a codespace with only an IDE or browser and a GitHub account. With a few configuration files, you can give your developers an instant, fully configured, and secure development environment so they can start coding immediately.
### Code from any device
Want to code on an iPad? Go for it. Spin up Codespaces from any device with internet access. Don’t worry if your device is powerful enough—Codespaces lives in the cloud.
### Onboard at the speed of thought
No more building your dev environment while you onboard. Codespaces launches instantly from any repository on GitHub with pre-configured, secure environments.
### Streamline contractor onboarding
Codespaces gives you control over how your consultants access your resources, while providing them with instant onboarding and a fluid developer experience.
### Fix bugs right from a pull request
Got a pull request detailing a bug or security issue? Open Codespaces right from the pull request without waiting for your dev environment to load.
“
Clint ChesterDeveloper Lead, Synergy
“
Keith AnnetteCloud Capability Lead, KPMG, UK
### Start coding in seconds with Codespaces
Go to any repository and open your own Codespaces environment instantly.
[Get started](/codespaces)
[Contact Sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=cta-banner&ref_page=%2Ffeatures%2Fcodespaces&utm_content=Platform&utm_medium=site&utm_source=github)
### Frequently asked questions
#### How does Codespaces work?
A codespace is a development environment that’s hosted in the cloud. Customize your project for GitHub Codespaces by [configuring dev container files](https://docs.github.com/codespaces/customizing-your-codespace/configuring-codespaces-for-your-project)
to your repository (often known as configuration-as-code), which creates a repeatable codespace configuration for all users of your project.
GitHub Codespaces run on a various VM-based compute options hosted by GitHub.com, which you can configure from 2 core machines up to 32 core machines. Connect to your codespaces from the browser or locally using an IDE like Visual Studio Code or IntelliJ.
#### How do I use Codespaces?
There are a number of entry points to spin up a Codespaces environment, including:
* A [template](https://docs.github.com/codespaces/getting-started/quickstart)
.
* [Your repository](https://docs.github.com/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)
for new feature work
* An [open pull request](https://docs.github.com/codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests#opening-a-pull-request-in-codespaces)
to explore work-in-progress
* A commit in the repository’s history to investigate a bug at a specific point in time
* [Visual Studio Code](https://docs.github.com/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code#creating-a-codespace-in-vs-code)
* In beta, can you also use your [JetBrains IDE](https://docs.github.com/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)
or [JupyterLab](https://docs.github.com/codespaces/developing-in-a-codespace/getting-started-with-github-codespaces-for-machine-learning)
Learn more about how to use Codespaces in our [documentation](https://docs.github.com/codespaces/overview)
.
#### Is Codespaces available for individual developers?
Codespaces is available for developers in every organization, and under the control of the organization who pays for the user’s codespace. All personal (individual) GitHub.com accounts include a quota of free usage each month, which organizations can enable (see the next question) for their private and internal repositories. GitHub will provide users in the free plan 120 core hours or 60 hours of run time on a 2 core codespace, plus 15 GB of storage each month. See how it’s balanced on the [billing page](https://github.com/settings/billing)
.
#### Is Codespaces available for teams and companies?
Codespaces is available for teams and companies, but needs to be enabled first in an organization’s settings. Teams and companies can select which repositories and users have access to Codespaces for added security and permissioning control. Learn how to [enable Codespaces in an organization in our docs](https://docs.github.com/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization)
.
#### How much does Codespaces cost?
Codespaces is free for individual use up to 60 hours a month and comes with simple, pay-as-you-go pricing after that. It’s also available for organizations with pay-as-you-go pricing and has pricing controls so any company or team can determine how much they want to spend a month. Learn more about Codespaces pricing for organizations [here](https://docs.github.com/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)
.
#### Can I self-host Codespaces?
Codespaces cannot be self-hosted.
#### How do I access Codespaces with LinkedIn Learning?
You can use Codespaces directly through LinkedIn Learning. LinkedIn Learning offers 50+ courses across six of the most popular coding languages, as well as data science and machine learning. These courses are integrated with Codespaces, so you can get hands-on practice anytime, from any machine via LinkedIn. These courses will be unlocked on LinkedIn Learning for free through Feb. 2023. Learn more about LinkedIn Learning and GitHub Codespaces [here](https://learning.linkedin.com/product/hands-on-practice)
.
#### How do I enable Codespaces on GitHub?
Codespaces is on by default for developers with a GitHub free account. If you belong to an organization, there may be a policy that prevents cloning—but if you can clone a repository, you will be able to start using Codespaces. Organizations will also need to pay for, enable, and manage their Codespaces instances.
#### Is Codespaces available for students?
Codespaces is available for free to students as part of the GitHub Student Developer Pack. Learn more about how to sign up and start using Codespaces and other GitHub products [here](https://education.github.com/pack)
.
#### Is Codespaces available for open source maintainers?
Codespaces provides both maintainers and contributors with [generous free monthly usage](https://docs.github.com/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts)
.
You can’t perform that action at this time.
---
# GitHub Code Search · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-features-code-search)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
Code Search
Exactly what you’re
looking for
=================================
With GitHub code search, your code—and the world’s—is at your fingertips.
[Try now](/search?type=code)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=hero&ref_page=%2Ffeatures%2Fcode-search&utm_content=Platform&utm_medium=site&utm_source=github)
### Fast, relevant results
Code search understands your code—and brings you relevant results with incredible speed.
### A power userʼs dream
Search using regular expressions, boolean operations, keyboard shortcuts, and more.
### More than just search
Dig deeper with the all-new code view—tightly integrating browsing and code navigation.
**Suggestions, completions, and more.** Use the new search input to find symbols and files—and jump right to them.
**Powerful search syntax.** Know exactly what you’re looking for? Express it with our powerful search operators.
**Code navigation.** Instantly jump to definitions in over 10 languages. No setup required.
**File browser.** Keep all your code in context and instantly switch files with the new file tree pane.
“
Keith SmileySoftware Engineer
“
Marco MontagnaPlatform Engineer
### Find more, search less
[Try now](/search?type=code)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=cta-banner&ref_page=%2Ffeatures%2Fcode-search&utm_content=Platform&utm_medium=site&utm_source=github)
### Frequently asked questions
#### Do I need to set up my repositories to support code navigation?
No, code navigation works out of the box, with zero configuration required.
#### Who can search my code?
Public code is searchable by anyone, but private code can only be searched by users who have access to it.
#### How much does the new code search and code view cost?
The new code search and code view are free for users of GitHub.com.
You can’t perform that action at this time.
---
# GitHub Copilot · Your AI pair programmer · GitHub
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub Copilot is now available for free
The AI editor for everyone
==========================
[Get started for free](https://github.com/copilot)
[See plans & pricing](/features/copilot/plans?cft=copilot_lo.features_copilot)
Already have  Visual Studio Code? [Open now](vscode://github.copilot-chat)
Pause
GitHub Copilot is used by
-------------------------
Pause
Pause
Pause
_Create tests, docs, and more._ Ask GitHub Copilot a question, get the right answer for you, and accept the code with a single click.[Our favorite Copilot prompts](https://docs.github.com/en/copilot/example-prompts-for-github-copilot-chat)
* _Answers that know how you code._ GitHub Copilot can use your code and custom instructions to code the way you prefer.
* _Your AI-powered teammate._ From debugging to deployment, GitHub Copilot generates what you need—so you can build faster.
### Choose your model
Use models like Anthropic's [Claude 3.5 Sonnet](https://docs.github.com/en/copilot/using-github-copilot/using-claude-sonnet-in-github-copilot)
, OpenAI o3, and GPT 4o to tackle coding tasks one minute—then dive into deeper reasoning the next.
Preview
### Here, there, and everywhere
In agent mode, Copilot gathers context across multiple files, suggests and tests edits, and validates changes for your approval, so you can make comprehensive updates with speed and accuracy.
[Try agent mode today](https://aka.ms/vscode-copilot-agent)
Preview
### Thank you, next
With next edit suggestions, GitHub Copilot predicts and adapts to your workflow—helping you code faster with less manual editing.
[Try next edit suggestions](https://aka.ms/gh-copilot-nes-docs)
### Instant feedback
Ask GitHub Copilot to review your work, uncover hidden bugs, fix mistakes, and more—before you get a human review.
[Get early access](https://github.com/features/preview/copilot-code-review)
[](https://github.com/features/preview/copilot-code-review)
### Extensions for your favorite tools
Check logs, create feature flags, and deploy apps—all from Copilot Chat, enhanced by an ecosystem of extensions from third party tools and services.
[Explore GitHub Copilot Extensions](https://github.com/features/copilot/extensions)
[](https://github.com/features/copilot/extensions)
### Ask for assistance right in your terminal
[Try Copilot in the CLI](https://docs.github.com/copilot/using-github-copilot/using-github-copilot-in-the-command-line)
### Chat with your AI pair programmer on-the-go
[](https://play.google.com/store/apps/details?id=com.github.android)
[](https://apps.apple.com/app/github/id1477376905?ls=1)
New
### Free
For developers looking to get started with GitHub Copilot.
$0 USD
[Get started](https://github.com/copilot)
Already have  VS Code? [Open now](vscode://github.copilot-chat)
Includes up to 2,000 completions and 50 chat requests per month.
Most popular
### Pro
For developers who want unlimited access to GitHub Copilot.
$10 USD
per month. First 30 days free.
[Get started](/github-copilot/signup/copilot_individual?cft=copilot_lo.features_copilot.cfi)
Free for verified students, teachers, and maintainers of popular open source projects. [Learn more](https://github.com/education)
### Business
For teams ready to accelerate their workflows with GitHub Copilot.
$19 USD
per user / month
[Get started](/github-copilot/purchase?priority=business&cft=copilot_lo.features_copilot.cfb)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=pricing&ref_page=%2Ffeatures%2Fcopilot&scid=&utm_campaign=Copilot_feature_page_contact_sales_cta_CopilotBusiness_utmroutercampaign&utm_medium=site&utm_source=github&cft=copilot_lo.features_copilot&utm_content=CopilotBusiness)
### Enterprise
For organizations seeking a fully customized GitHub Copilot experience.
$39 USD
per user / month
[Get started](/github-copilot/purchase?priority=enterprise&cft=copilot_lo.features_copilot.ce)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=pricing&ref_page=%2Ffeatures%2Fcopilot&scid=&utm_campaign=Copilot_feature_page_contact_sales_cta_CopilotEnterprise_utmroutercampaign&utm_medium=site&utm_source=github&cft=copilot_lo.features_copilot&utm_content=CopilotEnterprise)
GitHub Copilot is available on your favorite platforms:
* [\
\
GitHub](https://github.com/copilot)
GitHub
* [\
\
VS Code](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
VS Code
* [\
\
Visual Studio](https://visualstudio.microsoft.com/github-copilot)
Visual Studio
* [\
\
Xcode](https://github.com/github/CopilotForXcode)
Xcode
* [\
\
JetBrains IDEs](https://plugins.jetbrains.com/plugin/17718-github-copilot)
JetBrains IDEs
* [\
\
Neovim](https://github.com/github/copilot.vim)
Neovim
* [\
\
Azure Data Studio](https://learn.microsoft.com/en-us/azure-data-studio/extensions/github-copilot-extension-overview)
Azure Data Studio
Compare features
Features
Free
Pro
Business
Enterprise
Pricing
$0
$10 per month
$19 per user / month
$39 per user / month
Chat
Chat
Messages and interactions
Free planUp to 50 per monthUp to 50 per month
Pro planUnlimitedUnlimited
Business planUnlimitedUnlimited
Enterprise planUnlimitedUnlimited
Access to OpenAI GPT-4o
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Access to OpenAI GPT-4.5
Free planNot included
Pro planNot included
Business planNot included
Enterprise planIncluded
Preview
Access to Anthropic Claude 3.5 Sonnet
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Access to Anthropic Claude 3.7 Sonnet
Free planNot included
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Access to OpenAI o1
Free planNot included
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Access to OpenAI o3-mini
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Access to Google Gemini 2.0 Flash
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Context-aware coding support and explanations
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Debugging and security remediation assistance
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Access to knowledge from top open source repositories
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Generate tests, docs, and more with slash commands
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Answers about issues, PRs, discussions, files, commits, etc.
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Web search powered by Bing
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Explain failed Actions jobs
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Multi-file editing in VS Code
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Switch between models
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Add images to prompts
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Code completion
Code completion
Real-time code suggestions
Free planUp to 2,000 per monthUp to 2,000 per month
Pro planUnlimitedUnlimited
Business planUnlimitedUnlimited
Enterprise planUnlimitedUnlimited
Preview
Next edit suggestions
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Comments to code
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Customization
Customization
Tailor chat conversations to your private codebase (unlimited repositories indexed)
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Unlimited integrations with GitHub Copilot Extensions
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Build a private extension for internal tooling
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Personalize responses with custom instructions
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Prompt files to store and share reusable instructions
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Attach knowledge bases to chat for organizational context
Free planNot included
Pro planNot included
Business planNot included
Enterprise planIncluded
Fine-tuned models for code completion (coming soon as add-on)
Free planNot included
Pro planNot included
Business planNot included
Enterprise planIncluded
Set coding guidelines for code review
Free planNot included
Pro planNot included
Business planNot included
Enterprise planIncluded
AI-native experiences
AI-native experiences
Inline chat and prompt suggestions
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Slash commands and context variables
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Commit message generation
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Summaries for pull requests
Free planNot included
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Code feedback in VS Code
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Explanations in Visual Studio’s Quick Info
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Debug assistant in Visual Studio
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Upgrade assistant for Java in VS Code
Free planNot included
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Code review in GitHub
Free planNot included
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Preview
Copilot Workspace in pull requests
Free planNot included
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Technical Preview access to Copilot Workspace
Free planNot included
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Supported environments
Supported environments
Editors and IDEs \- [See all supported editors](https://docs.github.com/en/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment)
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
github.com
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
GitHub Mobile
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
GitHub CLI
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Windows Terminal
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
Management and policies
Management and policies
Public code filter with code referencing
Free planIncluded
Pro planIncluded
Business planIncluded
Enterprise planIncluded
User management
Free planNot included
Pro planNot included
Business planIncluded
Enterprise planIncluded
Data excluded from training by default
Free planNot included
Pro planNot included
Business planIncluded
Enterprise planIncluded
Enterprise-grade security
Free planNot included
Pro planNot included
Business planIncluded
Enterprise planIncluded
IP indemnity
Free planNot included
Pro planNot included
Business planIncluded
Enterprise planIncluded
Content exclusions
Free planNot included
Pro planNot included
Business planIncluded
Enterprise planIncluded
SAML SSO authentication [1](#footnote-1)
Free planNot included
Pro planNot included
Business planIncluded
Enterprise planIncluded
Usage metrics
Free planNot included
Pro planNot included
Business planIncluded
Enterprise planIncluded
Requires GitHub Enterprise Cloud
Free planNot included
Pro planNot included
Business planNot included
Enterprise planIncluded
How to get started
[Get started](https://github.com/copilot)
[Get started](/github-copilot/signup/copilot_individual?cft=copilot_lo.features_copilot.cfi)
[Get started](/github-copilot/purchase?priority=business&cft=copilot_lo.features_copilot.cfb)
[Get started](/github-copilot/purchase?priority=enterprise&cft=copilot_lo.features_copilot.ce)
### [Preview the latest features](https://github.com/features/preview)
Be the first to explore what’s next for GitHub Copilot.
See previews
### [Explore The GitHub Blog](https://github.blog/)
Discover the latest in software development with insights, best practices, and more.
Read Blog
### [Visit the GitHub Copilot Trust Center](https://copilot.github.trust.page/)
Gain peace of mind with our security, privacy, and responsible AI policies.
Go to Trust Center
### Frequently asked questions
#### General
#### What is GitHub Copilot?
GitHub Copilot transforms the developer experience. Backed by the leaders in AI, Copilot provides contextualized assistance throughout the software development lifecycle, from code completions and chat assistance in the IDE to code explanations and answers to docs in GitHub and more. With Copilot elevating their workflow, developers can focus on more: value, innovation, and happiness.
GitHub Copilot enables developers to focus more energy on problem solving and collaboration and spend less effort on the mundane and boilerplate. That’s why developers who use Copilot report up to 75% higher satisfaction with their jobs than those who don’t and are up to 55% more productive at writing code without sacrifice to quality, which all adds up to engaged developers shipping great software faster.
GitHub Copilot integrates with leading editors, including Visual Studio Code, Visual Studio, JetBrains IDEs, and Neovim, and, unlike other AI coding assistants, is natively built into GitHub. Growing to millions of individual users and tens of thousands of business customers, Copilot is the world’s most widely adopted AI developer tool and the competitive advantage developers ask for by name.
#### Who is eligible to access GitHub Copilot for free?
GitHub Copilot Free is a new free pricing tier with limited functionality for individual developers. Users assigned a Copilot Business or Copilot Enterprise seat are not eligible for access. Users with access to Copilot Pro through a paid subscription, trial, or through an existing verified OSS, Student, Faculty, or MVP account may elect to use Free instead.
#### What languages, IDEs, and platforms does GitHub Copilot support?
GitHub Copilot is trained on all languages that appear in public repositories. For each language, the quality of suggestions you receive may depend on the volume and diversity of training data for that language. For example, JavaScript is well-represented in public repositories and is one of GitHub Copilot’s best supported languages. Languages with less representation in public repositories may produce fewer or less robust suggestions.
GitHub Copilot is available as an extension in Visual Studio Code, Visual Studio, Vim, Neovim, the JetBrains suite of IDEs, and Azure Data Studio. Although code completion functionality is available across all these extensions, chat functionality is currently available only in Visual Studio Code, JetBrains and Visual Studio. GitHub Copilot is also supported in terminals through GitHub CLI and as a chat integration in Windows Terminal Canary. With the GitHub Copilot Enterprise plan, GitHub Copilot is natively integrated into GitHub.com. All plans are supported in GitHub Copilot in GitHub Mobile. GitHub Mobile for Copilot Pro and Copilot Business have access to Bing and public repository code search. Copilot Enterprise in GitHub Mobile gives you additional access to your organization's knowledge.
#### Does GitHub Copilot “copy/paste”?
No, GitHub Copilot generates suggestions using probabilistic determination.
* When thinking about intellectual property and open source issues, it is critical to understand how GitHub Copilot really works. The AI models that create Copilot’s suggestions may be trained on public code, but do not contain any code. When they generate a suggestion, they are not “copying and pasting” from any codebase.
* To generate a code suggestion, the Copilot extension begins by examining the code in your editor—focusing on the lines just before and after your cursor, but also information including other files open in your editor and the URLs of repositories or file paths to identify relevant context. That information is sent to Copilot’s model, to make a probabilistic determination of what is likely to come next and generate suggestions.
* To generate a suggestion for chat in the code editor, the Copilot extension creates a contextual prompt by combining your prompt with additional context including the code file open in your active document, your code selection, and general workspace information, such as frameworks, languages, and dependencies. That information is sent to Copilot’s model, to make a probabilistic determination of what is likely to come next and generate suggestions.
* To generate a suggestion for chat on GitHub.com, such as providing an answer to a question from your chat prompt, Copilot creates a contextual prompt by combining your prompt with additional context including previous prompts, the open pages on GitHub.com as well as retrieved context from your codebase or Bing search. That information is sent to Copilot’s model, to make a probabilistic determination of what is likely to come next and generate suggestions.
#### What are the differences between the GitHub Copilot Business, GitHub Copilot Enterprise, and GitHub Copilot Individual plans?
GitHub Copilot has multiple offerings for organizations and an offering for individual developers. All the offerings include both code completion and chat assistance. The primary differences between the organization offerings and the individual offering are license management, policy management, and IP indemnity.
Organizations can choose between GitHub Copilot Business and GitHub Copilot Enterprise. GitHub Copilot Business primarily features GitHub Copilot in the coding environment - that is the IDE, CLI and GitHub Mobile. GitHub Copilot Enterprise includes everything in GitHub Copilot Business. It also adds an additional layer of customization for organizations and integrates into GitHub.com as a chat interface to allow developers to converse with Copilot throughout the platform. GitHub Copilot Enterprise can index an organization’s codebase for a deeper understanding of the customer’s knowledge for more tailored suggestions and will offer customers access to fine-tuned custom, private models for code completion.
GitHub Copilot Individual is designed for individual developers, freelancers, students, educators, and open source maintainers. The plan includes all the features of GitHub Copilot Business except organizational license management, policy management, and IP indemnity.
#### What data has GitHub Copilot been trained on?
GitHub Copilot is powered by generative AI models developed by GitHub, OpenAI, and Microsoft. It has been trained on natural language text and source code from publicly available sources, including code in public repositories on GitHub.
#### Which plan includes GitHub Copilot Autofix?
GitHub Copilot Autofix provides contextual explanations and code suggestions to help developers fix vulnerabilities in code, and is included in [GitHub Advanced Security](https://github.com/enterprise/advanced-security)
.
#### What if I do not want GitHub Copilot?
Copilot is entirely optional and requires you to opt in before gaining access. You can easily configure its usage directly in the editor, enabling or disabling it at any time. Additionally, you have control over which file types Copilot is active for.
#### How do I control access to GitHub Copilot in my company?
Access to Copilot Business and Enterprise is managed by your GitHub Administrator. They can control access to preview features, models, and set Copilot policies for your organization. Additionally, you can use your network firewall to explicitly allow access to Copilot Business and/or block access to Copilot Pro or Free. For more details, refer to the [documentation](https://docs.github.com/en/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization)
.
#### Plans & Pricing
#### What are the differences between the Free, Pro, Business, and Enterprise plans?
GitHub Copilot has multiple offerings for organizations and an offering for individual developers. All the offerings include both code completion and chat assistance. The primary differences between the organization offerings and the individual offering are license management, policy management, and IP indemnity.
Organizations can choose between GitHub Copilot Business and GitHub Copilot Enterprise. GitHub Copilot Business primarily features GitHub Copilot in the coding environment - that is the IDE, CLI and GitHub Mobile. GitHub Copilot Enterprise includes everything in GitHub Copilot Business. It also adds an additional layer of customization for organizations and integrates into GitHub.com as a chat interface to allow developers to converse with Copilot throughout the platform. GitHub Copilot Enterprise can index an organization’s codebase for a deeper understanding of the customer’s knowledge for more tailored suggestions and will offer customers access to fine-tuned custom, private models for code completion.
GitHub Copilot Pro is designed for individual developers, freelancers, students, educators, and open source maintainers. The plan includes all the features of GitHub Copilot Business except organizational license management, policy management, and IP indemnity.
#### How can I upgrade my GitHub Copilot Free license to Copilot Pro?
If you're on the Free plan, you can upgrade to Pro through your [Copilot settings page](https://github.com/settings/copilot)
or directly on the [Copilot marketing page](https://github.com/features/copilot)
.
#### What is included in GitHub Copilot Free?
GitHub Copilot Free users are limited to 2000 completions and 50 chat requests (including Copilot Edits).
#### Which plan includes GitHub Copilot Autofix?
GitHub Copilot Autofix provides contextual explanations and code suggestions to help developers fix vulnerabilities in code, and is included in GitHub Advanced Security and available to all public repositories.
#### Privacy
#### What personal data does GitHub Copilot process?
GitHub Copilot processes personal data based on how Copilot is accessed and used: whether via GitHub.com, mobile app, extensions, or one of various IDE extensions, or through features like suggestions for the command line interface (CLI), IDE code completions, or personalized chat on GitHub.com. The types of personal data processed may include:
* **User Engagement Data:** This includes pseudonymous identifiers captured on user interactions with Copilot, such as accepted or dismissed completions, error messages, system logs, and product usage metrics.
* **Prompts:** These are inputs for chat or code, along with context, sent to Copilot's AI to generate suggestions.
* **Suggestions:** These are the AI-generated code lines or chat responses provided to users based on their prompts.
* **Feedback Data:** This comprises real-time user feedback, including reactions (e.g., thumbs up/down) and optional comments, along with feedback from support tickets.
#### Does GitHub use Copilot Business or Enterprise data to train GitHub’s model?
No. GitHub does not use either Copilot Business or Enterprise data to train its models.
#### How does GitHub use the Copilot data?
How GitHub uses Copilot data depends on how the user accesses Copilot and for what purpose. Users can access GitHub Copilot through the web, extensions, mobile apps, computer terminal, and various IDEs (Integrated Development Environments). GitHub generally uses personal data to:
* Deliver, maintain, and update the services as per the customer's configuration and usage, to ensure personalized experiences and recommendations
* Troubleshoot, which involves preventing, detecting, resolving, and mitigating issues, including security incidents and product-related problems, by fixing software bugs and maintaining the online services' functionality and up-to-dateness
* Enhance user productivity, reliability, effectiveness, quality, privacy, accessibility, and security by keeping the service current and operational
These practices are outlined in GitHub’s Data Protection Agreement ([DPA)](https://github.com/customer-terms/github-data-protection-agreement)
, which details our data handling commitments to our data controller customers.
GitHub also uses certain personal data with customer authorization under the DPA, for the following purposes:
* Billing and account management
* To comply with and resolve legal obligations
* For abuse detection, prevention, and protection, virus scanning, and scanning to detect violations of terms of service
* To generate summary reports for calculating employee commissions and partner incentives
* To produce aggregated reports for internal use and strategic planning, covering areas like forecasting, revenue analysis, capacity planning, and product strategy,
For details on GitHub's data processing activities as a controller, particularly for Copilot Pro customers, refer to the [GitHub Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement)
.
#### How long does GitHub retain Copilot data for Business and Enterprise customers?
If and for how long GitHub’s retains Copilot data depends on how a Copilot user accesses Copilot and for what purpose. The default settings for Copilot Business and Enterprise Customers are as follows:
**Access through IDE for Chat and Code Completions:**
* Prompts and Suggestions: Not retained
* User Engagement Data: Kept for two years.
* Feedback Data: Stored for as long as needed for its intended purpose.
**All other GitHub Copilot access and use:**
* Prompts and Suggestions: Retained for 28 days.
* User Engagement Data: Kept for two years.
* Feedback Data: Stored for as long as needed for its intended purpose.
#### Why do some Copilot features retain prompts and suggestions?
Retaining prompts and suggestions is necessary for chat on github.com, mobile, and CLI Copilot because those features’ effectiveness depends on using thread history to improve responses. The Copilot model requires access to previous interactions to deliver accurate and relevant suggestions.
#### Does GitHub Copilot support compliance with the GDPR and other data protection laws?
Yes. GitHub and customers can enter a [Data Protection Agreement](https://github.com/customer-terms/github-data-protection-agreement)
that supports compliance with the GDPR and similar legislation.
#### Does GitHub Copilot ever output personal data?
While we've designed GitHub Copilot with privacy in mind, the expansive definition of personal data under legislation like the EU’s General Data Protection Regulation (GDPR) means we can't guarantee it will never output such data. The Large Language Model (LLM) powering GitHub Copilot was trained on public code and there were instances in our tests where the tool made suggestions resembling personal data. These suggestions were typically synthesized and not tied to real individuals.
#### How does Copilot allow users to access, alter or delete personal data?
These actions are available to Copilot users as described in the [GitHub Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement#your-privacy-rights)
.
#### Responsible AI
#### What are the intellectual property considerations when using GitHub Copilot?
The primary IP considerations for GitHub Copilot relate to copyright. The model that powers Copilot is trained on a broad collection of publicly accessible code, which may include copyrighted code, and Copilot’s suggestions (in rare instances) may resemble the code its model was trained on. Here’s some basic information you should know about these considerations:
Copyright law permits the use of copyrighted works to train AI models: Countries around the world have provisions in their copyright laws that enable machines to learn, understand, extract patterns, and facts from copyrighted materials, including software code. For example, the European Union, Japan, and Singapore, have express provisions permitting machine learning to develop AI models. Other countries including Canada, India, and the United States also permit such training under their fair use/fair dealing provisions. GitHub Copilot’s AI model was trained with the use of code from GitHub’s public repositories—which are publicly accessible and within the scope of permissible copyright use.
What about copyright risk in suggestions? In rare instances (less than 1% based on GitHub’s research), suggestions from GitHub may match examples of code used to train GitHub’s AI model. Again, Copilot does not “look up” or “copy and paste” code, but is instead using context from a user’s workspace to synthesize and generate a suggestion.
Our experience shows that matching suggestions are most likely to occur in two situations: (i) when there is little or no context in the code editor for Copilot’s model to synthesize, or (ii) when a matching suggestion represents a common approach or method. If a code suggestion matches existing code, there is risk that using that suggestion could trigger claims of copyright infringement, which would depend on the amount and nature of code used, and the context of how the code is used. In many ways, this is the same risk that arises when using any code that a developer does not originate, such as copying code from an online source, or reusing code from a library. That is why responsible organizations and developers recommend that users employ code scanning policies to identify and evaluate potential matching code.
In Copilot, you can opt whether to allow Copilot to suggest code completions that match publicly available code on GitHub.com. For more information, see "[Configuring GitHub Copilot settings on GitHub.com](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code)
". If you have allowed suggestions that match public code, GitHub Copilot can provide you with details about the matching code when you accept such suggestions. Matching code does not necessarily mean copyright infringement, so it is ultimately up to the user to determine whether to use the suggestion, and what and who to attribute (along with other license compliance) in appropriate circumstances.
#### Does GitHub Copilot include a filtering mechanism to mitigate risk?
Yes, GitHub Copilot does include an optional code referencing filter to detect and suppress certain suggestions that match public code on GitHub.
* GitHub has created a duplication detection filter to detect and suppress suggestions that contain code segments over a certain length that match public code on GitHub. This filter can be enabled by the administrator for your enterprise and it can apply for all organizations within your enterprise, or the administrator can defer control to individual organizations.
* With the filter enabled, Copilot checks code suggestions for matches or near-matches against public code on GitHub of 65 lexemes or more (on average,150 characters). If there is a match, the suggestion will not be shown to the user.
* In addition to off-topic, harmful, and offensive output filters, GitHub Copilot also scans the outputs for vulnerable code.
#### Does GitHub Copilot include features to make it easier for users to identify potentially relevant open source licenses for matching suggestions?
Yes, GitHub Copilot is previewing a [code referencing feature](https://github.blog/2023-08-03-introducing-code-referencing-for-github-copilot/)
as an additional tool to assist users to find and review potentially relevant open source licenses. Code referencing is currently available in Visual Studio Code. This feature searches across public GitHub repositories for code that matches a Copilot suggestion. If there’s a match, users will find its information displayed in the Copilot console log, including where the match occurred, any applicable licenses, and a deep link to learn more. The deep link will take users to a navigable page on GitHub.com to browse examples of the code match and their repository licenses, and see how many repositories—including ones without licenses—that code appears in, as well as links to those repositories. Copilot users can review this information to determine whether the applicable suggestions are suitable for use, and whether additional measures may be necessary to use them.
#### Who owns the suggestions provided by GitHub Copilot?
We don’t determine whether a suggestion is capable of being owned, but we are clear that GitHub does not claim ownership of a suggestion. Whether a suggestion generated by an AI model can be owned depends on many factors (e.g. the intellectual property law in the relevant country, the length of the suggestion, the extent that suggestion is considered ‘functional’ instead of expressive, etc).
* If a suggestion is capable of being owned, our terms are clear: GitHub does not claim ownership.
* GitHub does not claim ownership of any suggestion. In certain cases, it is possible for Copilot to produce similar suggestions to different users. For example, two unrelated users both starting new files to code the quicksort algorithm in Java will likely get the same suggestion. The possibility of providing similar suggestions to multiple users is a common part of generative AI systems.
#### Can GitHub Copilot introduce insecure code in its suggestions?
Public code may contain insecure coding patterns, bugs, or references to outdated APIs or idioms. When GitHub Copilot synthesizes code suggestions based on this data, it can also synthesize code that contains these undesirable patterns. Copilot has filters in place that either block or notify users of insecure code patterns that are detected in Copilot suggestions. These filters target the most common vulnerable coding patterns, including [hardcoded credentials](https://cwe.mitre.org/data/definitions/798.html)
, [SQL injections](https://cwe.mitre.org/data/definitions/89.html)
, and [path injections](https://cwe.mitre.org/data/definitions/22.html)
. Additionally, in recent years we’ve provided tools such as GitHub Advanced Security, GitHub Actions, Dependabot, and CodeQL to open source projects to help improve code quality. Of course, you should always use GitHub Copilot together with good testing and code review practices and security tools, as well as your own judgment.
#### Is GitHub Copilot intended to fully automate code generation and replace developers?
No. Copilot is a tool intended to make developers more efficient. It’s not intended to replace developers, who should continue to apply the same sorts of safeguards and diligence they would apply with regard to any third-party code of unknown origin.
* The product is called “Copilot” not “Autopilot” and it’s not intended to generate code without oversight. You should use exactly the same sorts of safeguards and diligence with Copilot’s suggestions as you would use with any third-party code.
* Identifying best practices for use of third party code is beyond the scope of this section. That said, whatever practices your organization currently uses – rigorous functionality testing, code scanning, security testing, etc. – you should continue these policies with Copilot’s suggestions. Moreover, you should make sure your code editor or editor does not automatically compile or run generated code before you review it.
#### Can GitHub Copilot users simply use suggestions without concern?
Not necessarily. GitHub Copilot users should align their use of Copilot with their respective risk tolerances.
* As noted above, GitHub Copilot is not intended to replace developers, or their individual skill and judgment, and is not intended to fully automate the process of code development. The same risks that apply to the use of any third-party code apply to the use of Copilot’s suggestions.
* Depending on your particular use case, you should consider implementing the protections discussed above. It is your responsibility to assess what is appropriate for the situation and implement appropriate safeguards.
* You’re entitled to IP indemnification from GitHub for the unmodified suggestions when Copilot’s filtering is enabled. If you do elect to enable this feature, the copyright responsibility is ours, not our customers. As part of our ongoing commitment to responsible AI, GitHub and Microsoft extends our IP indemnity and protection support to our customers who are empowering their teams with GitHub Copilot. See [Microsoft's Copilot Copyright Commitment](https://blogs.microsoft.com/on-the-issues/2023/09/07/copilot-copyright-commitment-ai-legal-concerns/)
for more details.
#### Does GitHub Copilot support accessibility features?
We are conducting internal testing of GitHub Copilot’s ease of use by developers with disabilities and working to ensure that GitHub Copilot is accessible to all developers. Please feel free to share your feedback on GitHub Copilot accessibility in our [feedback forum](https://github.com/github-community/community/discussions/categories/copilot)
.
#### Does GitHub Copilot produce offensive outputs?
GitHub Copilot includes filters to block offensive language in the prompts and to avoid synthesizing suggestions in sensitive contexts. We continue to work on improving the filter system to more intelligently detect and remove offensive outputs. If you see offensive outputs, please report them directly to [copilot-safety@github.com](mailto:copilot-safety@github.com)
so that we can improve our safeguards. GitHub takes this challenge very seriously and we are committed to addressing it.
#### Will GitHub Copilot work as well using languages other than English?
Given public sources are predominantly in English, GitHub Copilot will likely work less well in scenarios where natural language prompts provided by the developer are not in English and/or are grammatically incorrect. Therefore, non-English speakers might experience a lower quality of service.
#### What data has GitHub Copilot been trained on?
GitHub Copilot is powered by generative AI models developed by GitHub, OpenAI, and Microsoft. It has been trained on natural language text and source code from publicly available sources, including code in public repositories on GitHub.
1. Data from June 2023. Additional research can be found [here](https://github.blog/news-insights/research/the-economic-impact-of-the-ai-powered-developer-lifecycle-and-lessons-from-github-copilot/)
.
2. Feature in public beta for Copilot Pro and Business plans. Requires use of repositories, issues, discussions, Actions, and other features of GitHub.
3. Authentication with SAML single sign-on (SSO) available for organizations using GitHub Enterprise Cloud.
GeneralPlans & PricingPrivacyResponsible AI
### General
#### What is GitHub Copilot?
GitHub Copilot transforms the developer experience. Backed by the leaders in AI, Copilot provides contextualized assistance throughout the software development lifecycle, from code completions and chat assistance in the IDE to code explanations and answers to docs in GitHub and more. With Copilot elevating their workflow, developers can focus on more: value, innovation, and happiness.
GitHub Copilot enables developers to focus more energy on problem solving and collaboration and spend less effort on the mundane and boilerplate. That’s why developers who use Copilot report up to 75% higher satisfaction with their jobs than those who don’t and are up to 55% more productive at writing code without sacrifice to quality, which all adds up to engaged developers shipping great software faster.
GitHub Copilot integrates with leading editors, including Visual Studio Code, Visual Studio, JetBrains IDEs, and Neovim, and, unlike other AI coding assistants, is natively built into GitHub. Growing to millions of individual users and tens of thousands of business customers, Copilot is the world’s most widely adopted AI developer tool and the competitive advantage developers ask for by name.
#### Who is eligible to access GitHub Copilot for free?
GitHub Copilot Free is a new free pricing tier with limited functionality for individual developers. Users assigned a Copilot Business or Copilot Enterprise seat are not eligible for access. Users with access to Copilot Pro through a paid subscription, trial, or through an existing verified OSS, Student, Faculty, or MVP account may elect to use Free instead.
#### What languages, IDEs, and platforms does GitHub Copilot support?
GitHub Copilot is trained on all languages that appear in public repositories. For each language, the quality of suggestions you receive may depend on the volume and diversity of training data for that language. For example, JavaScript is well-represented in public repositories and is one of GitHub Copilot’s best supported languages. Languages with less representation in public repositories may produce fewer or less robust suggestions.
GitHub Copilot is available as an extension in Visual Studio Code, Visual Studio, Vim, Neovim, the JetBrains suite of IDEs, and Azure Data Studio. Although code completion functionality is available across all these extensions, chat functionality is currently available only in Visual Studio Code, JetBrains and Visual Studio. GitHub Copilot is also supported in terminals through GitHub CLI and as a chat integration in Windows Terminal Canary. With the GitHub Copilot Enterprise plan, GitHub Copilot is natively integrated into GitHub.com. All plans are supported in GitHub Copilot in GitHub Mobile. GitHub Mobile for Copilot Pro and Copilot Business have access to Bing and public repository code search. Copilot Enterprise in GitHub Mobile gives you additional access to your organization's knowledge.
#### Does GitHub Copilot “copy/paste”?
No, GitHub Copilot generates suggestions using probabilistic determination.
* When thinking about intellectual property and open source issues, it is critical to understand how GitHub Copilot really works. The AI models that create Copilot’s suggestions may be trained on public code, but do not contain any code. When they generate a suggestion, they are not “copying and pasting” from any codebase.
* To generate a code suggestion, the Copilot extension begins by examining the code in your editor—focusing on the lines just before and after your cursor, but also information including other files open in your editor and the URLs of repositories or file paths to identify relevant context. That information is sent to Copilot’s model, to make a probabilistic determination of what is likely to come next and generate suggestions.
* To generate a suggestion for chat in the code editor, the Copilot extension creates a contextual prompt by combining your prompt with additional context including the code file open in your active document, your code selection, and general workspace information, such as frameworks, languages, and dependencies. That information is sent to Copilot’s model, to make a probabilistic determination of what is likely to come next and generate suggestions.
* To generate a suggestion for chat on GitHub.com, such as providing an answer to a question from your chat prompt, Copilot creates a contextual prompt by combining your prompt with additional context including previous prompts, the open pages on GitHub.com as well as retrieved context from your codebase or Bing search. That information is sent to Copilot’s model, to make a probabilistic determination of what is likely to come next and generate suggestions.
#### What are the differences between the GitHub Copilot Business, GitHub Copilot Enterprise, and GitHub Copilot Individual plans?
GitHub Copilot has multiple offerings for organizations and an offering for individual developers. All the offerings include both code completion and chat assistance. The primary differences between the organization offerings and the individual offering are license management, policy management, and IP indemnity.
Organizations can choose between GitHub Copilot Business and GitHub Copilot Enterprise. GitHub Copilot Business primarily features GitHub Copilot in the coding environment - that is the IDE, CLI and GitHub Mobile. GitHub Copilot Enterprise includes everything in GitHub Copilot Business. It also adds an additional layer of customization for organizations and integrates into GitHub.com as a chat interface to allow developers to converse with Copilot throughout the platform. GitHub Copilot Enterprise can index an organization’s codebase for a deeper understanding of the customer’s knowledge for more tailored suggestions and will offer customers access to fine-tuned custom, private models for code completion.
GitHub Copilot Individual is designed for individual developers, freelancers, students, educators, and open source maintainers. The plan includes all the features of GitHub Copilot Business except organizational license management, policy management, and IP indemnity.
#### What data has GitHub Copilot been trained on?
GitHub Copilot is powered by generative AI models developed by GitHub, OpenAI, and Microsoft. It has been trained on natural language text and source code from publicly available sources, including code in public repositories on GitHub.
#### Which plan includes GitHub Copilot Autofix?
GitHub Copilot Autofix provides contextual explanations and code suggestions to help developers fix vulnerabilities in code, and is included in [GitHub Advanced Security](https://github.com/enterprise/advanced-security)
.
#### What if I do not want GitHub Copilot?
Copilot is entirely optional and requires you to opt in before gaining access. You can easily configure its usage directly in the editor, enabling or disabling it at any time. Additionally, you have control over which file types Copilot is active for.
#### How do I control access to GitHub Copilot in my company?
Access to Copilot Business and Enterprise is managed by your GitHub Administrator. They can control access to preview features, models, and set Copilot policies for your organization. Additionally, you can use your network firewall to explicitly allow access to Copilot Business and/or block access to Copilot Pro or Free. For more details, refer to the [documentation](https://docs.github.com/en/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization)
.
### Plans & Pricing
#### What are the differences between the Free, Pro, Business, and Enterprise plans?
GitHub Copilot has multiple offerings for organizations and an offering for individual developers. All the offerings include both code completion and chat assistance. The primary differences between the organization offerings and the individual offering are license management, policy management, and IP indemnity.
Organizations can choose between GitHub Copilot Business and GitHub Copilot Enterprise. GitHub Copilot Business primarily features GitHub Copilot in the coding environment - that is the IDE, CLI and GitHub Mobile. GitHub Copilot Enterprise includes everything in GitHub Copilot Business. It also adds an additional layer of customization for organizations and integrates into GitHub.com as a chat interface to allow developers to converse with Copilot throughout the platform. GitHub Copilot Enterprise can index an organization’s codebase for a deeper understanding of the customer’s knowledge for more tailored suggestions and will offer customers access to fine-tuned custom, private models for code completion.
GitHub Copilot Pro is designed for individual developers, freelancers, students, educators, and open source maintainers. The plan includes all the features of GitHub Copilot Business except organizational license management, policy management, and IP indemnity.
#### How can I upgrade my GitHub Copilot Free license to Copilot Pro?
If you're on the Free plan, you can upgrade to Pro through your [Copilot settings page](https://github.com/settings/copilot)
or directly on the [Copilot marketing page](https://github.com/features/copilot)
.
#### What is included in GitHub Copilot Free?
GitHub Copilot Free users are limited to 2000 completions and 50 chat requests (including Copilot Edits).
#### Which plan includes GitHub Copilot Autofix?
GitHub Copilot Autofix provides contextual explanations and code suggestions to help developers fix vulnerabilities in code, and is included in GitHub Advanced Security and available to all public repositories.
### Privacy
#### What personal data does GitHub Copilot process?
GitHub Copilot processes personal data based on how Copilot is accessed and used: whether via GitHub.com, mobile app, extensions, or one of various IDE extensions, or through features like suggestions for the command line interface (CLI), IDE code completions, or personalized chat on GitHub.com. The types of personal data processed may include:
* **User Engagement Data:** This includes pseudonymous identifiers captured on user interactions with Copilot, such as accepted or dismissed completions, error messages, system logs, and product usage metrics.
* **Prompts:** These are inputs for chat or code, along with context, sent to Copilot's AI to generate suggestions.
* **Suggestions:** These are the AI-generated code lines or chat responses provided to users based on their prompts.
* **Feedback Data:** This comprises real-time user feedback, including reactions (e.g., thumbs up/down) and optional comments, along with feedback from support tickets.
#### Does GitHub use Copilot Business or Enterprise data to train GitHub’s model?
No. GitHub does not use either Copilot Business or Enterprise data to train its models.
#### How does GitHub use the Copilot data?
How GitHub uses Copilot data depends on how the user accesses Copilot and for what purpose. Users can access GitHub Copilot through the web, extensions, mobile apps, computer terminal, and various IDEs (Integrated Development Environments). GitHub generally uses personal data to:
* Deliver, maintain, and update the services as per the customer's configuration and usage, to ensure personalized experiences and recommendations
* Troubleshoot, which involves preventing, detecting, resolving, and mitigating issues, including security incidents and product-related problems, by fixing software bugs and maintaining the online services' functionality and up-to-dateness
* Enhance user productivity, reliability, effectiveness, quality, privacy, accessibility, and security by keeping the service current and operational
These practices are outlined in GitHub’s Data Protection Agreement ([DPA)](https://github.com/customer-terms/github-data-protection-agreement)
, which details our data handling commitments to our data controller customers.
GitHub also uses certain personal data with customer authorization under the DPA, for the following purposes:
* Billing and account management
* To comply with and resolve legal obligations
* For abuse detection, prevention, and protection, virus scanning, and scanning to detect violations of terms of service
* To generate summary reports for calculating employee commissions and partner incentives
* To produce aggregated reports for internal use and strategic planning, covering areas like forecasting, revenue analysis, capacity planning, and product strategy,
For details on GitHub's data processing activities as a controller, particularly for Copilot Pro customers, refer to the [GitHub Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement)
.
#### How long does GitHub retain Copilot data for Business and Enterprise customers?
If and for how long GitHub’s retains Copilot data depends on how a Copilot user accesses Copilot and for what purpose. The default settings for Copilot Business and Enterprise Customers are as follows:
**Access through IDE for Chat and Code Completions:**
* Prompts and Suggestions: Not retained
* User Engagement Data: Kept for two years.
* Feedback Data: Stored for as long as needed for its intended purpose.
**All other GitHub Copilot access and use:**
* Prompts and Suggestions: Retained for 28 days.
* User Engagement Data: Kept for two years.
* Feedback Data: Stored for as long as needed for its intended purpose.
#### Why do some Copilot features retain prompts and suggestions?
Retaining prompts and suggestions is necessary for chat on github.com, mobile, and CLI Copilot because those features’ effectiveness depends on using thread history to improve responses. The Copilot model requires access to previous interactions to deliver accurate and relevant suggestions.
#### Does GitHub Copilot support compliance with the GDPR and other data protection laws?
Yes. GitHub and customers can enter a [Data Protection Agreement](https://github.com/customer-terms/github-data-protection-agreement)
that supports compliance with the GDPR and similar legislation.
#### Does GitHub Copilot ever output personal data?
While we've designed GitHub Copilot with privacy in mind, the expansive definition of personal data under legislation like the EU’s General Data Protection Regulation (GDPR) means we can't guarantee it will never output such data. The Large Language Model (LLM) powering GitHub Copilot was trained on public code and there were instances in our tests where the tool made suggestions resembling personal data. These suggestions were typically synthesized and not tied to real individuals.
#### How does Copilot allow users to access, alter or delete personal data?
These actions are available to Copilot users as described in the [GitHub Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement#your-privacy-rights)
.
### Responsible AI
#### What are the intellectual property considerations when using GitHub Copilot?
The primary IP considerations for GitHub Copilot relate to copyright. The model that powers Copilot is trained on a broad collection of publicly accessible code, which may include copyrighted code, and Copilot’s suggestions (in rare instances) may resemble the code its model was trained on. Here’s some basic information you should know about these considerations:
Copyright law permits the use of copyrighted works to train AI models: Countries around the world have provisions in their copyright laws that enable machines to learn, understand, extract patterns, and facts from copyrighted materials, including software code. For example, the European Union, Japan, and Singapore, have express provisions permitting machine learning to develop AI models. Other countries including Canada, India, and the United States also permit such training under their fair use/fair dealing provisions. GitHub Copilot’s AI model was trained with the use of code from GitHub’s public repositories—which are publicly accessible and within the scope of permissible copyright use.
What about copyright risk in suggestions? In rare instances (less than 1% based on GitHub’s research), suggestions from GitHub may match examples of code used to train GitHub’s AI model. Again, Copilot does not “look up” or “copy and paste” code, but is instead using context from a user’s workspace to synthesize and generate a suggestion.
Our experience shows that matching suggestions are most likely to occur in two situations: (i) when there is little or no context in the code editor for Copilot’s model to synthesize, or (ii) when a matching suggestion represents a common approach or method. If a code suggestion matches existing code, there is risk that using that suggestion could trigger claims of copyright infringement, which would depend on the amount and nature of code used, and the context of how the code is used. In many ways, this is the same risk that arises when using any code that a developer does not originate, such as copying code from an online source, or reusing code from a library. That is why responsible organizations and developers recommend that users employ code scanning policies to identify and evaluate potential matching code.
In Copilot, you can opt whether to allow Copilot to suggest code completions that match publicly available code on GitHub.com. For more information, see "[Configuring GitHub Copilot settings on GitHub.com](https://docs.github.com/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code)
". If you have allowed suggestions that match public code, GitHub Copilot can provide you with details about the matching code when you accept such suggestions. Matching code does not necessarily mean copyright infringement, so it is ultimately up to the user to determine whether to use the suggestion, and what and who to attribute (along with other license compliance) in appropriate circumstances.
#### Does GitHub Copilot include a filtering mechanism to mitigate risk?
Yes, GitHub Copilot does include an optional code referencing filter to detect and suppress certain suggestions that match public code on GitHub.
* GitHub has created a duplication detection filter to detect and suppress suggestions that contain code segments over a certain length that match public code on GitHub. This filter can be enabled by the administrator for your enterprise and it can apply for all organizations within your enterprise, or the administrator can defer control to individual organizations.
* With the filter enabled, Copilot checks code suggestions for matches or near-matches against public code on GitHub of 65 lexemes or more (on average,150 characters). If there is a match, the suggestion will not be shown to the user.
* In addition to off-topic, harmful, and offensive output filters, GitHub Copilot also scans the outputs for vulnerable code.
#### Does GitHub Copilot include features to make it easier for users to identify potentially relevant open source licenses for matching suggestions?
Yes, GitHub Copilot is previewing a [code referencing feature](https://github.blog/2023-08-03-introducing-code-referencing-for-github-copilot/)
as an additional tool to assist users to find and review potentially relevant open source licenses. Code referencing is currently available in Visual Studio Code. This feature searches across public GitHub repositories for code that matches a Copilot suggestion. If there’s a match, users will find its information displayed in the Copilot console log, including where the match occurred, any applicable licenses, and a deep link to learn more. The deep link will take users to a navigable page on GitHub.com to browse examples of the code match and their repository licenses, and see how many repositories—including ones without licenses—that code appears in, as well as links to those repositories. Copilot users can review this information to determine whether the applicable suggestions are suitable for use, and whether additional measures may be necessary to use them.
#### Who owns the suggestions provided by GitHub Copilot?
We don’t determine whether a suggestion is capable of being owned, but we are clear that GitHub does not claim ownership of a suggestion. Whether a suggestion generated by an AI model can be owned depends on many factors (e.g. the intellectual property law in the relevant country, the length of the suggestion, the extent that suggestion is considered ‘functional’ instead of expressive, etc).
* If a suggestion is capable of being owned, our terms are clear: GitHub does not claim ownership.
* GitHub does not claim ownership of any suggestion. In certain cases, it is possible for Copilot to produce similar suggestions to different users. For example, two unrelated users both starting new files to code the quicksort algorithm in Java will likely get the same suggestion. The possibility of providing similar suggestions to multiple users is a common part of generative AI systems.
#### Can GitHub Copilot introduce insecure code in its suggestions?
Public code may contain insecure coding patterns, bugs, or references to outdated APIs or idioms. When GitHub Copilot synthesizes code suggestions based on this data, it can also synthesize code that contains these undesirable patterns. Copilot has filters in place that either block or notify users of insecure code patterns that are detected in Copilot suggestions. These filters target the most common vulnerable coding patterns, including [hardcoded credentials](https://cwe.mitre.org/data/definitions/798.html)
, [SQL injections](https://cwe.mitre.org/data/definitions/89.html)
, and [path injections](https://cwe.mitre.org/data/definitions/22.html)
. Additionally, in recent years we’ve provided tools such as GitHub Advanced Security, GitHub Actions, Dependabot, and CodeQL to open source projects to help improve code quality. Of course, you should always use GitHub Copilot together with good testing and code review practices and security tools, as well as your own judgment.
#### Is GitHub Copilot intended to fully automate code generation and replace developers?
No. Copilot is a tool intended to make developers more efficient. It’s not intended to replace developers, who should continue to apply the same sorts of safeguards and diligence they would apply with regard to any third-party code of unknown origin.
* The product is called “Copilot” not “Autopilot” and it’s not intended to generate code without oversight. You should use exactly the same sorts of safeguards and diligence with Copilot’s suggestions as you would use with any third-party code.
* Identifying best practices for use of third party code is beyond the scope of this section. That said, whatever practices your organization currently uses – rigorous functionality testing, code scanning, security testing, etc. – you should continue these policies with Copilot’s suggestions. Moreover, you should make sure your code editor or editor does not automatically compile or run generated code before you review it.
#### Can GitHub Copilot users simply use suggestions without concern?
Not necessarily. GitHub Copilot users should align their use of Copilot with their respective risk tolerances.
* As noted above, GitHub Copilot is not intended to replace developers, or their individual skill and judgment, and is not intended to fully automate the process of code development. The same risks that apply to the use of any third-party code apply to the use of Copilot’s suggestions.
* Depending on your particular use case, you should consider implementing the protections discussed above. It is your responsibility to assess what is appropriate for the situation and implement appropriate safeguards.
* You’re entitled to IP indemnification from GitHub for the unmodified suggestions when Copilot’s filtering is enabled. If you do elect to enable this feature, the copyright responsibility is ours, not our customers. As part of our ongoing commitment to responsible AI, GitHub and Microsoft extends our IP indemnity and protection support to our customers who are empowering their teams with GitHub Copilot. See [Microsoft's Copilot Copyright Commitment](https://blogs.microsoft.com/on-the-issues/2023/09/07/copilot-copyright-commitment-ai-legal-concerns/)
for more details.
#### Does GitHub Copilot support accessibility features?
We are conducting internal testing of GitHub Copilot’s ease of use by developers with disabilities and working to ensure that GitHub Copilot is accessible to all developers. Please feel free to share your feedback on GitHub Copilot accessibility in our [feedback forum](https://github.com/github-community/community/discussions/categories/copilot)
.
#### Does GitHub Copilot produce offensive outputs?
GitHub Copilot includes filters to block offensive language in the prompts and to avoid synthesizing suggestions in sensitive contexts. We continue to work on improving the filter system to more intelligently detect and remove offensive outputs. If you see offensive outputs, please report them directly to [copilot-safety@github.com](mailto:copilot-safety@github.com)
so that we can improve our safeguards. GitHub takes this challenge very seriously and we are committed to addressing it.
#### Will GitHub Copilot work as well using languages other than English?
Given public sources are predominantly in English, GitHub Copilot will likely work less well in scenarios where natural language prompts provided by the developer are not in English and/or are grammatically incorrect. Therefore, non-English speakers might experience a lower quality of service.
#### What data has GitHub Copilot been trained on?
GitHub Copilot is powered by generative AI models developed by GitHub, OpenAI, and Microsoft. It has been trained on natural language text and source code from publicly available sources, including code in public repositories on GitHub.
1. Data from June 2023. Additional research can be found [here](https://github.blog/news-insights/research/the-economic-impact-of-the-ai-powered-developer-lifecycle-and-lessons-from-github-copilot/)
.
2. Feature in public beta for Copilot Pro and Business plans. Requires use of repositories, issues, discussions, Actions, and other features of GitHub.
3. Authentication with SAML single sign-on (SSO) available for organizations using GitHub Enterprise Cloud.
Footnotes
---------
1. [Authentication with SAML single sign-on (SSO)](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)
available for organizations using GitHub Enterprise Cloud.[](#footnote-ref-1-1)
You can’t perform that action at this time.
---
# GitHub Security · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-features-security)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub Security
Security at every step
======================
AI-powered native application security testing
[Contact sales](https://github.com/enterprise/contact?ref_cta=Contact+Sales&ref_loc=hero&ref_page=%2Ffeatures%2Fsecurity&scid=&utm_campaign=adv-security&utm_content=Security&utm_medium=site&utm_source=github)
[Request a demo](https://resources.github.com/demo/advanced-security/)
### Enterprise-Grade
Secure your public and private repositories and leverage the power of Copilot
[GitHub Advanced Security](https://github.com/enterprise/advanced-security)
### Powering DevSecOps
Leverage automation and AI to help your developers ship secure code
[Get the checklist](https://resources.github.com/security/ai-powered-devsecops-checklist/)
### Security at Scale
Learn how a global consulting firm automates security testing for 12K developers
[Read the customer story](https://github.com/customer-stories/accenture)
### Find and fix vulnerabilities 7x faster
With AI-powered application security testing tools embedded in your development workflow, GitHub Advanced Security outperforms non-native add-ons by delivering 7x faster remediation rates for identified vulnerabilities.
[Secure your code](https://github.com/features/security/code-scanning)
### vs code
_Find vulnerabilities and suppress false positives_ with more than 2,000 queries from GitHub and the open-source community.
[Learn more about CodeQL](https://github.blog/2023-03-31-codeql-zero-to-hero-part-1-the-fundamentals-of-static-analysis-for-vulnerability-research/)
* Leverage machine learning to detect security issues in your pull requests and prevent new vulnerabilities from entering main.
* Prioritize alerts and view exposure across the codebase to make sure you focus on what matters. Automatically resolve alerts with AI-powered auto-remediation.
### Software supply chains, secure by design
GitHub supply chain security is designed for developers, built for speed, and free for everyone. All powered by a database of over 12,000 expert-reviewed advisories.
[Secure your software supply chain](https://github.com/features/security/software-supply-chain)
### Detect and prevent secret leaks
Keep secrets out of your code with secret scanning and push protection, built on the foundation of 100+ partners and 200+ token types. Create custom patterns and detect leaked passwords, powered by AI.
[Secret scanning is now free for all public repositories](https://github.blog/2023-02-28-secret-scanning-alerts-are-now-available-and-free-for-all-public-repositories/)
### Complete visibility into your enterprise
Security overview provides a cross-organizational view of security issues and trends so that you can focus on prioritizing remediation efforts and track progress over time.
[Explore GitHub Enterprise](http://www.github.com/enterprise)
### Be part of the world’s largest security community
Report security issues, share security knowledge and grow with the community. Contribute to open source code scanning queries written by GitHub and leading security researchers.
[Publish a repository security advisory](https://securitylab.github.com/)
### Security at every step
AI-powered native application security testing
[Contact sales](https://github.com/enterprise/contact?ref_cta=Contact+Sales&ref_loc=cta%2Fbanner&ref_page=%2Ffeatures%2Fsecurity&scid=&utm_campaign=adv-security&utm_content=Security&utm_medium=site&utm_source=github)
[Request a demo](https://resources.github.com/demo/advanced-security/)
### [Developer-first application security](https://resources.github.com/security/supply-chain/shipping-fast-secure-supply-chain/)
Take an in-depth look at the current state of application security.
Learn more
### [Proactive vs Reactive Security](https://resources.github.com/security/proactive-security/)
Prevent security issues from happening in the first place.
Prevent security issues
### [Static application security testing SAST](https://resources.github.com/security/sast/)
Discover what SAST is and how to get started with SAST.
Learn more about SAST
You can’t perform that action at this time.
---
# GitHub Discussions · Developer Collaboration & Communication Tool · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-features-discussions)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub Discussions
The home for
developer communities
====================================
Ask questions, share ideas, and build connections with each other—all right next to your code. GitHub Discussions enables healthy and productive software collaboration.
[Try now](https://docs.github.com/discussions/quickstart)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=hero&ref_page=%2Ffeatures%2Fdiscussions&utm_content=Platform&utm_medium=site&utm_source=github)
Screenshot of a GitHub Discussions page for the ’octoinvaders’ project, showing categorized discussion threads with tags like ’answered’ and ’Long term.’ The interface features playful elements like a mona emjoi and a rocket icon, highlighting community interaction.
**Mark what’s most helpful.** Highlight quality responses and make the best answer more discoverable for future community members to find.
**Thread conversations.** Keep context in-tact and conversations on track with threaded comments.
**Ask your community with polls.** Gauge interest in a feature, vote on a meetup time, or learn more about your community with custom polls.
**Leverage GraphQL API and webhooks.** Decrease maintainer burden by integrating your workflows where your teams already are.
**Give your open ended conversations the room they need outside of issues.** Convert discussions into issues when you’re ready to scope out work.
### Customize
_Personalize for your community and team with any ways to make your space unique for you and your collaborators._
* _Custom categories_ Create discussion categories that fit your communityʼs needs.
* _Label and organize_ Make announcements and the most important discussions more visible for contributors.
* _Pin discussions_ Make announcements and the most important discussions more visible for contributors.
### Contribution activity
Count of total contribution activity to Discussions, Issues, and PRs.
### Discussions page views
Total page views to Discussions segmented by logged in vs anonymous users.
### Discussions daily contributors
Count of unique users who have reacted, upvoted, marked an answer, commented, or posted in the selected period.
[\
\
### Next.js\
\
10k+ discussions](https://github.com/vercel/next.js/discussions)
[\
\
### TailwindCSS\
\
3k+ discussions](https://github.com/tailwindlabs/tailwindcss/discussions)
[\
\
### Homebrew\
\
4k+ discussions](https://github.com/Homebrew/discussions/discussions)
[\
\
### Bootstrap\
\
600+ discussions](https://github.com/twbs/bootstrap/discussions)
[\
\
### Laravel\
\
1.6k+ discussions](https://github.com/laravel/framework/discussions)
[\
\
### D3.js\
\
30k+ discussions](https://github.com/d3/d3/discussions)
[\
\
### Symfony\
\
700+ discussions](https://github.com/symfony/symfony/discussions)
[\
\
### VueJS\
\
50+ discussions](https://github.com/vuejs/core/discussions)
### Start the conversation with your community
[Try now](https://docs.github.com/discussions/quickstart)
[Contact sales](/enterprise/contact?ref_cta=Contact+sales&ref_loc=cta-banner&ref_page=%2Ffeatures%2Fdiscussions&utm_content=Platform&utm_medium=site&utm_source=github)
You can’t perform that action at this time.
---
# GitHub for teams · Build like the best teams on the planet · GitHub
GitHub Copilot is now available for free. [Learn more](https://github.com/features/copilot/?utm_source=github&utm_medium=banner&utm_campaign=copilotfree-bannerheader-team)
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
GitHub for Teams
================
Build like the best teams on the planet
---------------------------------------
With CI/CD, Dependabot, and the world’s largest developer community, GitHub gives your team everything they need to ship better software faster.
[Get started with Team](/join?plan=business&ref_cta=Get%2520started%2520with%2520Team&ref_loc=team-page-hero&ref_page=%2Fteam)
[Sign up for free](/join?plan=free&ref_cta=Sign%2520up%2520for%2520free&ref_loc=team-page-hero&ref_page=%2Fteam&setup_organization=true&source=team)
     
  
Compare Plans
-------------
Ready to get your
team started?
### GitHub Free
Basics for teams
and developers
* Unlimited public/private repositories
* 2,000 Actions minutes/month
* 500MB of GitHub Packages storage
* Community Support
[Get started for free](/join?plan=free&ref_cta=Get%2520started%2520for%2520free&ref_loc=bottom%2520plans&ref_page=%2Fteam&setup_organization=true&source=team)
Need SAML, self-hosting, or priority support?
[Learn more about GitHub Enterprise](/enterprise)
### GitHub Team
Advanced collaboration and deployment
features for teams
* Everything included in Free, plus ...
* 3,000 Actions minutes/month
* 2GB of GitHub Packages storage
* GitHub Codespaces
* Protected branches
* Multiple reviewers in pull requests
* Code owners
* Draft pull requests
* Required reviewers
* Pages and Wikis
* Web-based support
[Continue with Team](/join?plan=business&ref_cta=Continue%2520with%2520Team&ref_loc=bottom%2520plans&ref_page=%2Fteam&setup_organization=true&source=bottom+plans-team)
Need something else?
[Compare all plans](/pricing)
* Peak Money
* Trustpilot
* Gatsby
* Tray.io
* Kubernetes
* Front
Collaboration
-------------
Manage everything in one place
**Connect your favorite tools**
Build the way that works best for you with support for all your go-to integrations, including [Slack](https://slack.github.com/)
, [Jira](https://github.com/marketplace/jira-software-github)
, and more.
**Add your team in a click**
Seamlessly update permissions and add new users as you build, whether you’re on a team of two or two thousand.
**Speed up code review**
Step up your code quality with code review tools that fit right into your workflow.
**Plan together**
Make it easy for project managers and developers to coordinate, track, and update their work in one place—so projects stay on schedule.
Peak Money logo
> “As a team, we’re way more confident that we’re in tune. We can all see our work, feedback, and roadmap going through GitHub.”
Automation
----------
Build CI/CD workflows that work for you
[\
\
**Checkout**\
\
Check out a Git repository at a particular version.\
\
name: Checkout \
uses: actions/checkout@v2.1.0](/marketplace/actions/checkout)
[\
\
**Set up Node.js environment**\
\
Set up a Node.js environment and add it to the PATH, providing additional proxy support.\
\
name: Set up Node.js for use with actions \
uses: actions/setup-node@v1.1.0](/marketplace/actions/setup-node-js-environment)
[\
\
**NPM Publish**\
\
Automatically publish packages to NPM.\
\
name: NPM Publish \
uses: JS DevTools/npm-publish@v1](/marketplace/actions/npm-publish)
**Streamline your CI/CD**
Build, test, and deploy projects on any OS, language, or cloud.
**Choose from thousands of actions**
Find community-built GitHub Actions workflows on GitHub Marketplace, or build your own.
**Respond to GitHub events**
Trigger workflows based on GitHub events, including push, issue creation, new releases, and more.
**Collaborate on workflows**
Build, share, improve, and reuse actions just like code.
[Explore GitHub Actions](/marketplace?type=actions)
Front App logo
> “With GitHub Actions, deployments happen 75 percent faster—taking about 10 minutes compared to the 40 minutes required when they were done manually.”
Security
--------
Stay focused on development
 
**Grant the right access to your team**
Easily grant, limit, or revoke access for collaborators inside and outside your company.
**Keep secrets safe**
Get alerts when secrets are committed to your repositories—and notify over 30 cloud service providers automatically.
**Find vulnerable dependencies**
Scan your dependencies automatically. When a vulnerability is found, we’ll open a pull request with suggested fixes.
[See how GitHub helps secure your applications](/features/security)
> “GitHub’s Dependabot security updates are smarter than any other vulnerability tracking tools we’ve used.”
       
Users
-----
Home to the world’s software teams
Meet your developers where they already are. GitHub is home to over 40 million developers and the world’s largest open source community.
150M+ million developers
1B+ billion contributions
4M+ million organizations
      
Customer Stories
----------------
You’re in good company
[Front App\
\
Customer Story\
\
Front App logo Read story](/customer-stories/front)
[Tray.io\
\
Customer Story\
\
Tray.io logo Read story](/customer-stories/trayio)
[Read more customer stories](/customer-stories?type=team)
Build like the best
-------------------
Get the complete developer platform
[Get started with Team](/join?plan=business&ref_cta=Get%2520started%2520with%2520Team&ref_loc=team-page-footer&ref_page=%2Fteam)
[Sign up for free](/join?plan=free&ref_cta=Sign%2520up%2520for%2520free&ref_loc=team-page-footer&ref_page=%2Fteam&setup_organization=true&source=team)
Related resources
-----------------
[### GitHub Actions cheat sheet\
\
Everything you need to know about getting started with GitHub Actions.\
\
Learn more](https://resources.github.com/actions/github-actions-cheat/)
[### Collaboration is the key to DevOps success\
\
In a recent TechTarget study, 70 percent of organizations reported they had adopted DevOps.\
\
Learn more](https://resources.github.com/whitepapers/Collaboration-DevOps-success/)
[### How healthy teams build better software\
\
Your culture is key to recruiting and retaining the talent you need to ship exceptional customer experiences.\
\
Learn more](https://resources.github.com/webcasts/Culture-matters-CET/)
You can’t perform that action at this time.
---
# Features - HackMD
Features === \*\*\[English version\](/features)\*\* \*\*\[中文版\](/features-tw)\*\* \*\*\[日本語版\](/features-jp)\*\* \*\*\[:arrow\_right: Check the source of this note :arrow\_left:\](/features?both)\*\* \*\*\[Read the complete tutorial\](https://hackmd.io/c/tutorials)\*\* Introduction === \*\*HackMD\*\* is a realtime, multi-platform collaborative markdown knowledge base. You can write notes with other people on your \*\*desktop\*\*, \*\*tablet\*\* or even on the \*\*phone\*\*. Please report new issues in \[GitHub\](https://github.com/hackmdio/hackmd-io-issues/issues/new). If you need instant help, please send us a \[Facebook message\](https://www.messenger.com/t/hackmdio). \*\*Thank you very much!\*\* Workspace === ## Modes \*\*Desktop & Tablet\*\* Edit: See only the editor. View: See only the result. Both: See both in split view. \*\*Mobile\*\* View: See only the result. Edit: See only the editor. ## Image Upload: You can upload an image simply by clicking on the camera button . Alternatively, you can \*\*drag-n-drop\*\* an image into the editor. Even \*\*pasting\*\* images works! Dragging and pasting will automatically upload the image to HackMD, nothing to worry. :tada: :::info :bulb: Free users can upload images up to 1 MB. Paid users can upload 20 MB. ::: ## Share Notes: Press the share button on the top right of the menu and click \*\*Copy\*\* button to copy the note URL link to your clipboard. To publish and customize the note URL with permalink, please read \*\*\[How to Publish a Note with Permalink\](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-publish-note)\*\*. ## Save a Note: Currently, you can save to \*\*Dropbox\*\* , \*\*Google Drive\*\*, \*\*Gist \*\* or save an \`.md\` file and \`.html\` locally. ## Import Notes: Similarly to the \_save\_ feature, you can also import an \`.md\` or \`.html\` file from \*\*Dropbox\*\* , \*\*Google Drive\*\*, \*\*Gist \*\* or import content from your \*\*clipboard\*\* , and that can parse some \*\*HTML\*\* which might be useful :smiley: ## Permissions: It is possible to change permissions to a note through the button on the share button on the top right of the menu, click the button and you will see the \*\*Sharing\*\* menu. For \*\*read\*\* and \*\*write\*\* permissions, you can either choose: \*\*Owners\*\*, \*\*Signed-in users\*\* or \*\*Everyone\*\*. For \*\*commenting\*\* permission, please click \*\*More\*\* in the sharing menu and choose either: \*\*Forbidden\*\*, \*\*Owners\*\*, \*\*Signed-in users\*\* or \*\*Everyone\*\*. You even can disable the commenting feature through the toggle to the right of the commenting label. \*\*Only the owners of the note can change above permissions.\*\* To invite specific user to a note, please read \*\*\[Invite Others to a Private Note\](https://hackmd.io/c/tutorials/%2Fs%2Finvite)\*\*. ## Embed a Note: Notes can be embedded using iframe as follows: \`\`\`xml \`\`\` Or you can use embed syntax to include a note seamlessly, please read \*\*\[Embedding another note\](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-embed-note)\*\*. ## \[Slide Mode\](/slide-example): You can use a special syntax to organize your note into slides. After that, you can use the \*\*Slide Mode\*\* to make a presentation. Visit the above link for details. ## \[Book Mode\](/book-example): You can make your notes into a book. List your links in order or nest them. Then use the \*\*Book Mode\*\* to make a collection. Visit the above link for details. View === ## Table of Contents: You can look at the bottom right section of the view area, there is a \_ToC\_ button . Pressing that button will show you a current \_Table of Contents\_, and will highlight which section you're at. If the view area is wide enough, to ToC will show directly at the right section of the view area. ToCs support up to \*\*three header levels\*\*. ## Header link Every header will automatically add a url link on the left side. You can hover and click to anchor on it. Edit: === ## Shortcut Keys: Just like Sublime text, which is pretty quick and convenient. > For more infomation, see \[here\](https://codemirror.net/demo/sublime.html). ## Auto-Complete: This editor provides full auto-complete hints in markdown. - Emojis: type \`:\` to show hints. - Code blocks: type \` \`\`\` \` and plus a character to show hint. \`\`\` - Headers: type \`#\` to show hint. - Referrals: type \`\[\]\` to show hint. - Externals: type \`{}\` to show hint. - Images: type \`!\` to show hint. ## Title: This will take the first \*\*level 1 header\*\* as the note title. ## Tags: Using tags as follows, the specified tags will show in your note list. ###### tags: \`features\` \`cool\` \`updated\` ## \[YAML Metadata\](/yaml-metadata) You can provide advanced note information to set the browser behavior (visit above link for details): - title: set note title - description: set note description - image: set note default image (for link preview) - tags: set note tags - robots: set web robots meta - lang: set browser language - dir: set text direction - breaks: set to use line breaks - GA: set to use Google Analytics - disqus: set to use Disqus - slideOptions: setup slide mode options ## ToC: Use the syntax \`\[TOC\]\` to embed table of content into your note. \[TOC\] ## Emoji You can type any emoji like this :smile: :smiley: :cry: :wink: > See full emoji list \[here\](https://github.com/ikatyang/emoji-cheat-sheet). ## ToDo List: - \[ \] ToDos - \[x\] Buy some salad - \[ \] Brush teeth - \[x\] Drink some water ## Code Block: We support many programming languages, use the auto complete function to see the entire list. \`\`\`javascript= var s = "JavaScript syntax highlighting"; alert(s); function $initHighlight(block, cls) { try { if (cls.search(/\\bno\\-highlight\\b/) != -1) return process(block, true, 0x0F) + ' class=""'; } catch (e) { /\* handle exception \*/ } for (var i = 0 / 2; i < classes.length; i++) { if (checkCondition(classes\[i\]) === undefined) return /\\d+\[\\s/\]/g; } } \`\`\` > If you want \*\*line numbers\*\*, type \`=\` after specifying the code block languages. > Also, you can specify the start line number. > Like below, the line number starts from 101: \`\`\`javascript=101 var s = "JavaScript syntax highlighting"; alert(s); function $initHighlight(block, cls) { try { if (cls.search(/\\bno\\-highlight\\b/) != -1) return process(block, true, 0x0F) + ' class=""'; } catch (e) { /\* handle exception \*/ } for (var i = 0 / 2; i < classes.length; i++) { if (checkCondition(classes\[i\]) === undefined) return /\\d+\[\\s/\]/g; } } \`\`\` > Or you might want to continue the previous code block's line number, use \`=+\` \`\`\`javascript=+ var s = "JavaScript syntax highlighting"; alert(s); \`\`\` > Sometimes you have a super long text without breaks. It's time to use \`!\` to wrap your code. \`\`\`! When you’re a carpenter making a beautiful chest of drawers, you’re not going to use a piece of plywood on the back. \`\`\` ### Blockquote Tags: > Using the syntax below to specifiy your \*\*name, time and color\*\* to vary the blockquotes. > \[name=ChengHan Wu\] \[time=Sun, Jun 28, 2015 9:59 PM\] \[color=#907bf7\] > > Even support the nest blockquotes! > > \[name=ChengHan Wu\] \[time=Sun, Jun 28, 2015 10:00 PM\] \[color=red\] ### Render CSV as table You can use write csv in the codeblock: ~~~md \`\`\`csvpreview {header="true"} firstName,lastName,email,phoneNumber John,Doe,john@doe.com,0123456789 Jane,Doe,jane@doe.com,9876543210 James,Bond,james.bond@mi6.co.uk,0612345678 \`\`\` ~~~ which rendered to: \`\`\`csvpreview {header="true"} firstName,lastName,email,phoneNumber John,Doe,john@doe.com,0123456789 Jane,Doe,jane@doe.com,9876543210 James,Bond,james.bond@mi6.co.uk,0612345678 \`\`\` We use \[Papa Parse\](https://www.papaparse.com/) for parsing csv. The parsing option is given in braces: \`{}\`, and multiple options are seperated by a space. e.g. \`{header="true" delimiter="."}\`. Please read \[their documentation\](https://www.papaparse.com/docs#config) as reference. ## Externals ### YouTube {%youtube 1G4isv\_Fylg %} ### Vimeo {%vimeo 124148255 %} ### Gist {%gist schacon/4277 %} ### SlideShare {%slideshare briansolis/26-disruptive-technology-trends-2016-2018-56796196 %} ### Speakerdeck {%speakerdeck sugarenia/xxlcss-how-to-scale-css-and-keep-your-sanity %} ### PDF \*\*Caution: this might be blocked by your browser if not using an \`https\` URL.\*\* {%pdf https://hackmd.io/pdf-sample.pdf %} ### Figma {%figma https://www.figma.com/file/FlUge76mJYUB4hsMyLbRXH/Primer-Primitives-Community?node-id=9%3A2 %} ## MathJax You can render \*LaTeX\* mathematical expressions using \*\*MathJax\*\*, as on \[math.stackexchange.com\](http://math.stackexchange.com/), except the space after the start \`$\` and the space before the end \`$\` are not allowed in the inline math: The \*Gamma function\* satisfying $\\Gamma(n) = (n-1)!\\quad\\forall n\\in\\mathbb N$ is via the Euler integral For block level math, please give \`$$\` and a line break before and after your math formula: $$ x = {-b \\pm \\sqrt{b^2-4ac} \\over 2a}. $$ $$ \\Gamma(z) = \\int\_0^\\infty t^{z-1}e^{-t}dt\\,. $$ > More information about \*\*LaTeX\*\* mathematical expressions \[here\](http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference). ## UML Diagrams ### Sequence Diagrams You can render sequence diagrams like this: \`\`\`sequence Alice->Bob: Hello Bob, how are you? Note right of Bob: Bob thinks Bob-->Alice: I am good thanks! Note left of Alice: Alice responds Alice->Bob: Where have you been? \`\`\` ### Flow Charts Flow charts can be specified like this: \`\`\`flow st=>start: Start e=>end: End op=>operation: My Operation op2=>operation: lalala cond=>condition: Yes or No? st->op->op2->cond cond(yes)->e cond(no)->op2 \`\`\` ### Graphviz \`\`\`graphviz digraph hierarchy { nodesep=1.0 // increases the separation between nodes node \[color=Red,fontname=Courier,shape=box\] //All nodes will this shape and colour edge \[color=Blue, style=dashed\] //All the lines look like this Headteacher->{Deputy1 Deputy2 BusinessManager} Deputy1->{Teacher1 Teacher2} BusinessManager->ITManager {rank=same;ITManager Teacher1 Teacher2} // Put them on the same level } \`\`\` ### Mermaid \`\`\`mermaid gantt title A Gantt Diagram section Section A task :a1, 2014-01-01, 30d Another task :after a1 , 20d section Another Task in sec :2014-01-12 , 12d anther task : 24d \`\`\` ### Abc \`\`\`abc X:1 T:Speed the Plough M:4/4 C:Trad. K:G |:GABc dedB|dedB dedB|c2ec B2dB|c2A2 A2BA| GABc dedB|dedB dedB|c2ec B2dB|A2F2 G4:| |:g2gf gdBd|g2f2 e2d2|c2ec B2dB|c2A2 A2df| g2gf g2Bd|g2f2 e2d2|c2ec B2dB|A2F2 G4:| \`\`\` ### PlantUML \`\`\`plantuml start if (condition A) then (yes) :Text 1; elseif (condition B) then (yes) :Text 2; stop elseif (condition C) then (yes) :Text 3; elseif (condition D) then (yes) :Text 4; else (nothing) :Text else; endif stop \`\`\` ### Vega-Lite \`\`\`vega { "$schema": "https://vega.github.io/schema/vega-lite/v4.json", "data": {"url": "https://vega.github.io/editor/data/barley.json"}, "mark": "bar", "encoding": { "x": {"aggregate": "sum", "field": "yield", "type": "quantitative"}, "y": {"field": "variety", "type": "nominal"}, "color": {"field": "site", "type": "nominal"} } } \`\`\` ### Fretboard \`\`\`fretboard {title="horizontal, 6 frets, with nut", type="h6"} -oO-\*- --o-o- -o-oo- -o-oO- -oo-o- -\*O-o- 3 \`\`\` > More information about \*\*sequence diagrams\*\* syntax \[here\](http://bramp.github.io/js-sequence-diagrams/). > More information about \*\*flow charts\*\* syntax \[here\](http://adrai.github.io/flowchart.js/). > More information about \*\*graphviz\*\* syntax \[here\](http://www.tonyballantyne.com/graphs.html) > More information about \*\*mermaid\*\* syntax \[here\](http://mermaid-js.github.io/mermaid) > More information about \*\*abc\*\* syntax \[here\](http://abcnotation.com/learn) > More information about \*\*vega\*\* syntax \[here\](https://vega.github.io/vega-lite/docs) > More information about \*\*fretboard\*\* syntax \[here\](https://hackmd.io/@docs/fretboard-syntax) Alert Area --- :::success Yes :tada: ::: :::info This is a message :mega: ::: :::warning Watch out :zap: ::: :::danger Oh No! :fire: ::: :::spoiler Click to show details You found me :stuck\_out\_tongue\_winking\_eye: ::: :::spoiler {state="open"} Expand the spoiler container by default You found me :stuck\_out\_tongue\_winking\_eye: ::: ## Typography ### Headers \`\`\` # h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading \`\`\` ### Horizontal Rules \_\_\_ --- \*\*\* ### Typographic Replacements Enable typographer option to see result. (c) (C) (r) (R) (tm) (TM) (p) (P) +- test.. test... test..... test?..... test!.... !!!!!! ???? ,, Remarkable -- awesome "Smartypants, double quotes" 'Smartypants, single quotes' ### Emphasis \*\*This is bold text\*\* \_\_This is bold text\_\_ \*This is italic text\* \_This is italic text\_ ~~Deleted text~~ lu~lala~ Superscript: 19^th^ Subscript: H~2~O ++Inserted text++ ==Marked text== {ruby base|rubytext} ### Blockquotes > Blockquotes can also be nested... >> ...by using additional greater-than signs right next to each other... > > > ...or with spaces between arrows. ### Lists #### Unordered + Create a list by starting a line with \`+\`, \`-\`, or \`\*\` + Sub-lists are made by indenting 2 spaces: - Marker character change forces new list start: \* Ac tristique libero volutpat at + Facilisis in pretium nisl aliquet - Nulla volutpat aliquam velit + Very easy! #### Ordered 1. Lorem ipsum dolor sit amet 2. Consectetur adipiscing elit 3. Integer molestie lorem at massa 1. You can use sequential numbers... --- 1. ...or keep all the numbers as \`1.\` 1. feafw 2. 332 3. 242 4. 2552 1. e2 Start numbering with offset: 57. foo 1. bar ### Code Inline \`code\` Indented code // Some comments line 1 of code line 2 of code line 3 of code Block code "fences" \`\`\` Sample text here... \`\`\` Syntax highlighting \`\`\`javascript var foo = function (bar) { return bar++; }; console.log(foo(5)); \`\`\` ### Tables | Option | Description | | ------ | ----------- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Right aligned columns | Option | Description | | ------:| -----------:| | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Left aligned columns | Option | Description | |:------ |:----------- | | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | Center aligned columns | Option | Description | |:------:|:-----------:| | data | path to data files to supply the data that will be passed into templates. | | engine | engine to be used for processing templates. Handlebars is the default. | | ext | extension to be used for dest files. | ### Links \[link text\](http://dev.nodeca.com) \[link with title\](http://nodeca.github.io/pica/demo/ "title text!") Autoconverted link https://github.com/nodeca/pica ### Images !\[Minion\](https://octodex.github.com/images/minion.png) !\[Stormtroopocat\](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat") Like links, Images also have a footnote style syntax !\[Alt text\]\[id\] With a reference later in the document defining the URL location: \[id\]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" !\[Minion\](https://octodex.github.com/images/minion.png =200x200) Show the image with given size ### Footnotes Footnote 1 link\[^first\]. Footnote 2 link\[^second\]. Inline footnote^\[Text of inline footnote\] definition. Duplicated footnote reference\[^second\]. \[^first\]: Footnote \*\*can have markup\*\* and multiple paragraphs. \[^second\]: Footnote text. ### Definition Lists Term 1 : Definition 1 with lazy continuation. Term 2 with \*inline markup\* : Definition 2 { some code, part of Definition 2 } Third paragraph of definition 2. \_Compact style:\_ Term 1 ~ Definition 1 Term 2 ~ Definition 2a ~ Definition 2b ### Abbreviations This is an HTML abbreviation example. It converts "HTML", but keeps intact partial entries like "xxxHTMLyyy" and so on. \*\[HTML\]: Hyper Text Markup Language
---
# Privacy - HackMD
Privacy === HackMD’s privacy policy is pretty straightforward: - We don’t ask for personal information unless we really need it. - We don’t sell your personal information. - We log some basic data (IP address, browser user-agent, session cookie) about all visitors. This information is typically discarded, but we occasionally use it for analytics and performance measurements. - For HackMD users, we may store personal information such as your \[Facebook\](https://www.facebook.com), \[GitHub\](https://github.com), \[Twitter\](https://twitter.com), \[Dropbox\](https://www.dropbox.com), \[Google\](https://www.google.com) username and your e-mail address and profile informations. If you delete your account, we will delete this information. - We use third party tools such as \[Google Analytics\](https://analytics.google.com), \[Mixpanel\](https://mixpanel.com). Some information-sharing with these third parties is unavoidable. For example, unless you use a privacy tool like \[Ghostery\](https://www.ghostery.com), Google will know your IP address, browser info, etc. Website Visitors --- Like most website operators, HackMD collects non-personally-identifying information of the sort that web browsers and servers typically make available, such as the browser type, language preference, referring site, and the date and time of each visitor request. Our purpose in collecting non-personally identifying information is to better understand how visitors use our website. From time to time, HackMD may release non-personally-identifying information in the aggregate, e.g., by publishing a report on trends in the usage of its website. HackMD also collects potentially personally-identifying information like Internet Protocol (IP) addresses for logged-in users. HackMD only discloses logged in user and commenter IP addresses under the same circumstances that it uses and discloses personally-identifying information as described below. Gathering of Personally-Identifying Information --- Certain visitors to our website choose to interact in ways that require HackMD to gather personally-identifying information. The amount and type of information that HackMD gathers depends on the nature of the interaction. For example, we ask visitors who sign up for an account to provide a username and email address. In each case, HackMD collects such information only insofar as is necessary or appropriate to fulfill the purpose of the visitor’s interaction with HackMD. HackMD does not disclose personally-identifying information other than as described below. And visitors can always refuse to supply personally-identifying information, with the caveat that it may prevent them from engaging in certain website-related activities. Aggregated Statistics --- HackMD may collect statistics about the behavior of visitors to its websites. HackMD may display this information publicly or provide it to others. However, HackMD does not disclose personally-identifying information other than as described below. Protection of Your Data --- Your data is encrypted in transit and at rest. Security procedures are in place to protect the confidentiality of your data. Protection of Certain Personally-Identifying Information --- HackMD discloses potentially personally-identifying and personally-identifying information only to those of its employees, contractors and affiliated organizations that (i) need to know that information in order to process it on behalf of HackMD or to provide services available at HackMD’s website, and (ii) that have agreed not to disclose it to others. Some of those employees, contractors and affiliated organizations may be located outside of your home country; by using HackMD, you consent to the transfer of such information to them. HackMD will not rent or sell potentially personally-identifying and personally-identifying information to anyone. Other than to its employees, contractors and affiliated organizations, as described above, HackMD discloses potentially personally-identifying and personally-identifying information only in response to a subpoena, court order or other governmental request, or when HackMD believes in good faith that disclosure is reasonably necessary to protect the property or rights of HackMD, third parties or the public at large. If you are a registered HackMD user and have supplied your email address, HackMD may occasionally send you an email to tell you about new features, solicit your feedback, or just keep you up to date with what’s going on with HackMD and our products. We expect to keep this type of email to a minimum. If you send us a request (for example via a support email or via one of our feedback mechanisms), we reserve the right to publish it in order to help us clarify or respond to your request or to help us support other users. HackMD takes all measures reasonably necessary to protect against the unauthorized access, use, alteration or destruction of potentially personally-identifying and personally-identifying information. Cookies --- A cookie is a string of information that a website stores on a visitor’s computer, and that the visitor’s browser provides to the website each time the visitor returns. HackMD uses cookies to help HackMD identify and track visitors, their usage of the HackMD website, and their website access preferences. HackMD visitors who do not wish to have cookies placed on their computers should set their browsers to refuse cookies before using the HackMD website, with the drawback that certain HackMD website features may not function properly without the aid of cookies. Privacy Policy Changes --- Although most changes are likely to be minor, HackMD may change its Privacy Policy from time to time, in its sole discretion. HackMD encourages visitors to frequently check this page for any changes to its Privacy Policy. Your continued use of this site after any change in this Privacy Policy will constitute your acceptance of such change. Accuracy and right to information --- We will make reasonable efforts to ensure that your Personal Data is correct and up-to-date. If you believe that any Personal Data stored by Us is incorrect, you are welcome to contact Us and provide us with correct data in order for Us to rectify and update your Personal Data. You may, once per calendar year, request information regarding Personal Data stored by Us. Such request, in writing and signed by you, shall be addressed to Us on the address below. Account and data deletion --- You can delete your account and data in '\[Settings\](https://hackmd.io/settings#general)' or send us an email at support@hackmd.io to request account and data deletion. Contact --- If You have any questions about how We use your Personal Data, you may contact us at support@hackmd.io Effective as from May 30, 2016.
---