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

      This note has no invitees

    • Publish Note

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

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Versions and GitHub Sync Note Insights Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

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

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       owned this note    owned this note      
    Published Linked with GitHub
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    [![hackmd-github-sync-badge](https://hackmd.io/Z6w4WVQdSeuByYdoTi1X2Q/badge)](https://hackmd.io/Z6w4WVQdSeuByYdoTi1X2Q) (also ideal for viewing) *In brief:* A curriculum for students of 'open source' as it is practiced by open source spftware developers. Whether you’re a newcomer to open source or you’ve been involved with the practice for some time, this curriculum aims to provide a comprehensive overview of everything open source is, and aspires to be. # Open-Source Curriculum (v0.1.1) This document aspires to become a comprehensive reading list for anyone seeking to deeply understand ‘openness’ as an ideology for knowledge work, a distributed movement, a commercial industry and more yet to come. #### Open Source as a subset of openness https://en.wikipedia.org/wiki/Openness > Openness is an overarching concept or philosophy that is characterized by an emphasis on transparency and collaboration. That is, openness refers to "accessibility of knowledge, technology and other resources; the transparency of action; the permeability of organisational structures; and the inclusiveness of participation". Openness can be said to be the opposite of closedness, central authority and secrecy. Since openness is such an expansive subject, we will start here with a narrow focus on openness as it pertains to software development and the internet-connected world. In software and *tech*, 'open source' is the most commonly practiced form of openness. As soon as you start delving into *software openness*, you'll begin hearing the term *open source*. Before long you'll also learn that there is a difference between what's called "open source" and "free". And you'll learn that these terms are defined both formally and informally. It's important to be aware that no one owns these terms. There is no central authority to say what "open source" means, just like there's no central authority on the term "democracy". Open Source (sometimes capitalized!) isn't limited to just software. Any *thing* with a blueprint that enables said thing to be inspected, duplicated or modified can be regarded as open source. This blueprint could be anything from the complete specification of an airplane, all the way down to the genetic code of a seed. The openness *movement* therefore extends far beyond the confines of software. From now on we will talk about the "openness movement" and "open source" somewhat interchangeably. Like it or not, "open source" is being adopted into the mainstream with new meanings attached to it that are way outside the scope of its origins. See for instance ["Open Sourced" by Vox](https://www.vox.com/open-sourced), a publication that is largely values-aligned with the open source movement, but has nothing to do with software licensing and open source practices. #### Curriculum highlights - What “open source” means - How openness is applied in software development - Economic & personal sustainability - Software ethics In the open source spirit, this curriculum is itself open source, I.e. permissively licensed. We will diligently review the change requests that are sent our way, with the intent of eventually having multiple co-editors. If someone strongly disagrees with how the editors exercise their final-edit powers, feel free to *fork* this curriculum. If you don’t yet know what that means, you’ll learn very soon! # What is open source If you're absolutely new to the very concept of open source, start by watching these two introductory videos. [https://www.youtube.com/watch?v=Tyd0FO0tko8&feature=youtu.be](https://www.youtube.com/watch?v=Tyd0FO0tko8&feature=youtu.be) [https://www.youtube.com/watch?v=a8fHgx9mE5U](https://www.youtube.com/watch?v=a8fHgx9mE5U) (HELP WANTED: Are you aware of a text/graphical writeup that explains open source in similar fashion to the videos above? We need one of those!) Creative Commons is also a very plain-English way of understanding the open source ethos through the lense of licensing. CC licenses are primarily intended for artifacts such as books, images and music. [https://creativecommons.org/share-your-work/](https://creativecommons.org/share-your-work/) [https://creativecommons.org/use-remix/cc-licenses/](https://creativecommons.org/use-remix/cc-licenses/) For now this curriculum will focus on software because... 1. Open source software is arguably the furthest ahead of any openness movement. 2. The author(s) of this curriculum are chiefly familiar with software. **Further Reading:** - [Working in Public: The Making and Maintenance of Open Source Software](https://www.amazon.com/Working-Public-Making-Maintenance-Software/dp/0578675862) by Nadia Eghbal ## History & Status Quo [https://en.wikipedia.org/wiki/History_of_free_and_open-source_software](https://en.wikipedia.org/wiki/History_of_free_and_open-source_software) [https://en.wikipedia.org/wiki/Open-source-software_movement](https://en.wikipedia.org/wiki/Open-source-software_movement) [https://opensource.org/history](https://opensource.org/history) [https://www.ufried.com/blog/oss_1_rise_of_oss/](https://www.ufried.com/blog/oss_1_rise_of_oss/) https://www.ufried.com/blog/oss_2_misconceptions/ https://www.ufried.com/blog/oss_3_today/ [https://steveklabnik.com/writing/the-culture-war-at-the-heart-of-open-source](https://steveklabnik.com/writing/the-culture-war-at-the-heart-of-open-source) [https://steveklabnik.com/writing/what-comes-after-open-source](https://steveklabnik.com/writing/what-comes-after-open-source) [https://blog.timescale.com/blog/open-source-demise-of-proprietary-software-a49f73f54165/](https://blog.timescale.com/blog/open-source-demise-of-proprietary-software-a49f73f54165/) Retort: https://news.ycombinator.com/item?id=21873337 https://venturebeat.com/2015/12/06/its-actually-open-source-software-thats-eating-the-world/ # Ideology ## Central authorities for the term “open source” There is no single authority that ratifies what can be deemed "open source" or not. There are however a few organisations that are widely regarded as highly trusted, and many people believe that their definitions of "open source" should be strictly adhered to. Chief among these is the Open Software Initiative. **[opensource.org](http://opensource.org) by Open Software Initiative** [https://opensource.org/osd-annotated](https://opensource.org/osd-annotated) [https://opensource.org/faq](https://opensource.org/faq) ❕ *Not to be confused with opensource.COM, an advocacy site for open source by the company Red Hat:* **[opensource.com](http://opensource.com) by Red Hat** [https://opensource.com/resources/what-open-source](https://opensource.com/resources/what-open-source) [https://opensource.com/open-source-way](https://opensource.com/open-source-way) **Opinion pieces on the open source definition** - [https://medium.com/@nayafia/evolving-the-term-open-source-902ce28a59b2](https://medium.com/@nayafia/evolving-the-term-open-source-902ce28a59b2) - [https://medium.com/@nayafia/i-hate-the-term-open-source-a65fd481a95](https://medium.com/@nayafia/i-hate-the-term-open-source-a65fd481a95) - [https://writing.kemitchell.com/2019/04/23/OSD-wontfix.html](https://writing.kemitchell.com/2019/04/23/OSD-wontfix.html) - [https://writing.kemitchell.com/2020/05/11/Open-Source-Property.html](https://writing.kemitchell.com/2020/05/11/Open-Source-Property.html) - [https://writing.kemitchell.com/2019/05/08/Tyranny-of-Permissionlessness.html](https://writing.kemitchell.com/2019/05/08/Tyranny-of-Permissionlessness.html) - [https://blog.licensezero.com/2018/09/16/two-party.html](https://blog.licensezero.com/2018/09/16/two-party.html) - [https://writing.kemitchell.com/2016/05/13/What-Open-Source-Means.html](https://writing.kemitchell.com/2016/05/13/What-Open-Source-Means.html) ## Why make anything open source At first glance, open source sharing might just seem like charitable giving. A philanthropic endeavor to make the world we inhabit more open to scrutiny and modification. Yet while a sense of charity is certainly felt by many open source contributors, the practical benefits of open source licensing also align perfectly well with [egoistic altruism](https://www.youtube.com/watch?v=rvskMHn0sqQ&vl=en) as well as common-sense business strategy. Economic incentives aside, the open source development methodology is simply an easier, more efficient way to develop software. Openly accessible knowledge gives way to more and better knowledge. ### Non-zero-sum - [https://www.britannica.com/topic/positive-sum-game](https://www.britannica.com/topic/positive-sum-game) - [https://conceptually.org/concepts/zero-vs-positive-sum](https://conceptually.org/concepts/zero-vs-positive-sum) - [https://youtu.be/wcZFIy2mfyE](https://youtu.be/wcZFIy2mfyE) ### Intrinsic Motivation https://www.ted.com/talks/dan_pink_the_puzzle_of_motivation ## "Open Source" vs "Free Software" https://www.youtube.com/watch?v=Ag1AKIl_2GM [https://www.gnu.org/philosophy/free-sw.en.html](https://www.gnu.org/philosophy/free-sw.en.html) ## Privilege & Inclusivity [https://www.npr.org/sections/codeswitch/2013/12/05/248791579/why-isnt-open-source-a-gateway-for-coders-of-color?t=1577575156872](https://www.npr.org/sections/codeswitch/2013/12/05/248791579/why-isnt-open-source-a-gateway-for-coders-of-color?t=1577575156872) [https://www.ashedryden.com/big-ruby-open-source-isnt-for-everyone-but-it-could-be](https://www.ashedryden.com/big-ruby-open-source-isnt-for-everyone-but-it-could-be) [https://dri.es/the-privilege-of-free-time-in-open-source](https://dri.es/the-privilege-of-free-time-in-open-source) [https://jlord.us/blog/osos-talk.html](https://jlord.us/blog/osos-talk.html) [https://www.peterkrautzberger.org/0193/](https://www.peterkrautzberger.org/0193/) [https://www.techrepublic.com/article/is-getting-paid-to-write-open-source-a-privilege-yes-and-no/](https://www.techrepublic.com/article/is-getting-paid-to-write-open-source-a-privilege-yes-and-no/) ## Ethics Is open source biased towards being for “good”? https://medium.com/@johnmark/why-open-source-failed-6cae5d6a9f6 [https://dev.to/degoodmanwilson/open-source-is-broken-g60](https://dev.to/degoodmanwilson/open-source-is-broken-g60) [https://firstdonoharm.dev/version/1/2/license.html](https://firstdonoharm.dev/version/1/2/license.html) http://ethics.fast.ai/ # Industry [https://www.cnbc.com/2019/12/14/how-open-source-software-became-the-new-industry-standard.html](https://www.cnbc.com/2019/12/14/how-open-source-software-became-the-new-industry-standard.html) [https://www.forbes.com/sites/forbestechcouncil/2018/07/16/how-open-source-became-the-default-business-model-for-software/](https://www.forbes.com/sites/forbestechcouncil/2018/07/16/how-open-source-became-the-default-business-model-for-software/) [https://www.youtube.com/watch?v=7XTHdcmjenI](https://www.youtube.com/watch?v=7XTHdcmjenI) (See the upcoming Civility chapter for a follow-up on Linus’ behavior. Linus himself has made some apologies in later times. Rigorous debate and politeness are in no way mutually exclusive.) https://changelog.com/topic/oss/podcasts ## Business Differentiators [https://ben.balter.com/2015/11/23/why-open-source/](https://ben.balter.com/2015/11/23/why-open-source/) [https://www.ycombinator.com/library/56-why-the-best-companies-and-developers-give-away-almost-everything-they-do](https://www.ycombinator.com/library/56-why-the-best-companies-and-developers-give-away-almost-everything-they-do) [https://blog.tommoor.com/2019/01/01/you-should-open-source-your-product/](https://blog.tommoor.com/2019/01/01/you-should-open-source-your-product/) [https://writing.kemitchell.com/2018/08/23/Selective-Mythology.html](https://writing.kemitchell.com/2018/08/23/Selective-Mythology.html) [https://changelog.com/podcast/322](https://changelog.com/podcast/322) [https://changelog.com/podcast/322#transcript-69](https://changelog.com/podcast/322#transcript-69) [https://changelog.com/podcast/322#transcript-91](https://changelog.com/podcast/322#transcript-91) [Dgraph notes](https://www.notion.so/Dgraph-notes-f5f3a9b07a824b62895c8377b5e5199a) [https://en.wikipedia.org/wiki/Vendor_lock-in](https://en.wikipedia.org/wiki/Vendor_lock-in) ## Business Strategy [https://en.wikipedia.org/wiki/Business_models_for_open-source_software](https://en.wikipedia.org/wiki/Business_models_for_open-source_software) [https://a16z.com/2019/10/04/commercializing-open-source/](https://a16z.com/2019/10/04/commercializing-open-source/) https://heathermeeker.com/2018/06/24/revisiting-the-open-source-business-model/ [https://blog.timescale.com/blog/how-open-source-software-makes-money-time-series-database-f3e4be409467/](https://blog.timescale.com/blog/how-open-source-software-makes-money-time-series-database-f3e4be409467/) [https://medium.com/blossom-capital/successful-open-source-business-models-2709e831e38a](https://medium.com/blossom-capital/successful-open-source-business-models-2709e831e38a) [https://indieopensource.com/](https://indieopensource.com/) [https://sfosc.org/](https://sfosc.org/) https://www.valueinopen.fm/ ### Open Core [https://www.coss.community/jj/open-core-definition-examples-tradeoffs-ahi](https://www.coss.community/jj/open-core-definition-examples-tradeoffs-ahi) [https://www.coss.community/jj/coss-company-value-creation-and-capture-fundamentals-3829](https://www.coss.community/jj/coss-company-value-creation-and-capture-fundamentals-3829) [https://www.coss.community/cossc/polyform-and-open-core-2oh6](https://www.coss.community/cossc/polyform-and-open-core-2oh6) # Sustainability [https://www.fordfoundation.org/work/learning/research-reports/roads-and-bridges-the-unseen-labor-behind-our-digital-infrastructure/](https://www.fordfoundation.org/work/learning/research-reports/roads-and-bridges-the-unseen-labor-behind-our-digital-infrastructure/) [https://dri.es/balancing-makers-and-takers-to-scale-and-sustain-open-source](https://dri.es/balancing-makers-and-takers-to-scale-and-sustain-open-source) [https://katedowninglaw.com/2019/09/08/the-great-open-source-shake-up/](https://katedowninglaw.com/2019/09/08/the-great-open-source-shake-up/) [https://writing.kemitchell.com/2019/09/09/Shake-Up.html](https://writing.kemitchell.com/2019/09/09/Shake-Up.html) [https://sustainoss.org/](https://sustainoss.org/) **Further Reading:** - [Governing the Commons](https://wtf.tw/ref/ostrom_1990.pdf) by Elinor Ostrom - https://www.resilience.org/stories/2013-11-01/governing-the-commons-by-elinor-ostrom-review/ - https://changelog.com/rfc - https://podcast.sustainoss.org/ ## Social pressure & Burnout [https://mikemcquaid.com/2018/03/19/open-source-maintainers-owe-you-nothing/](https://mikemcquaid.com/2018/03/19/open-source-maintainers-owe-you-nothing/) [https://nolanlawson.com/2017/03/05/what-it-feels-like-to-be-an-open-source-maintainer/](https://nolanlawson.com/2017/03/05/what-it-feels-like-to-be-an-open-source-maintainer/) [https://writing.jan.io/2017/03/06/sustainable-open-source-the-maintainers-perspective-or-how-i-learned-to-stop-caring-and-love-open-source.html](https://writing.jan.io/2017/03/06/sustainable-open-source-the-maintainers-perspective-or-how-i-learned-to-stop-caring-and-love-open-source.html) http://www.saurik.com/id/20 # Methodology Open source is also a way of working. ## Open Source Methodologies - https://www.apache.org/foundation/how-it-works.html - https://www.redhat.com/en/about/development-model - https://opensource.com/open-organization - https://www.linuxfoundation.org/resources/open-source-guides/ - https://opensource.guide/ - https://github.com/sfosc/sfosc/blob/master/SOCIAL_CONTRACT.md ## Inner Source https://en.wikipedia.org/wiki/Inner_source > Inner source is the use of open source software development best practices and the establishment of an open source-like culture within organizations. The organization may still develop proprietary software, but internally opens up its development. [https://writing.kemitchell.com/2019/01/12/Outer-Source.html](https://writing.kemitchell.com/2019/01/12/Outer-Source.html) ## Distributed Work https://www.welcometothejungle.com/en/articles/btc-remote-open-source https://distributed.blog/ https://basecamp.com/books/remote # Community ## The Open Source Community https://opensource.com/government/10/10/what-open-source-community https://medium.com/@djhersh/community-software-is-dead-431d9f347ee6 https://medium.com/sustainable-free-and-open-source-communities/we-need-sustainable-free-and-open-source-communities-edf92723d619 ## Community Building **Starter Pack:** https://adevait.com/blog/workplace/build-open-source-community https://opensource.guide/building-community/ [https://github.com/hintjens/socialarchitecture](https://github.com/hintjens/socialarchitecture) https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951 **Further Reading:** https://www.jonobacon.com/books/peoplepowered/ :star2: https://www.penguinrandomhouse.com/books/300615/here-comes-everybody-by-clay-shirky/ :star2: - https://www.linuxfoundation.org/resources/open-source-guides/building-leadership-in-an-open-source-community/ - https://www.carriemelissajones.com/blog/community-commitment-curve - https://wptavern.com/pippin-williamson-on-building-a-community-around-your-open-source-project - https://www.jonobacon.com/2019/04/29/open-source-example/ - https://www.snoyman.com/blog/2017/10/effective-ways-help-from-maintainers - https://blog.discourse.org/2018/08/launching-a-successful-discourse-community/ - https://blog.discord.com/how-to-build-an-active-and-engaged-indie-game-community-with-discord-4a5be74d822e - https://communityroundtable.com/best-practices/perks-community-wall-flower-users-lurk/ - https://opensource.com/business/11/1/six-ways-build-solid-community - https://www.feverbee.com/strategy/ - https://cmxhub.com/build-a-thriving-community-from-scratch/ - https://www.i-scoop.eu/online-communities-social-communities-primer/ - https://www.zdnet.com/article/twelve-best-practices-for-online-customer-communities/ # Licensing ## Fundamentals https://opensource.com/article/17/9/open-source-licensing https://heathermeeker.com/open-source-faq/basic-open-source-software-licensing/ https://heathermeeker.com/open-source-faq/what-should-my-company-know-about-open-source/ https://blog.usejournal.com/understanding-open-source-and-free-software-licensing-c0fa600106c9 **Further Reading:** - https://www.amazon.com/dp/B086G6XDM1/ - [https://writing.kemitchell.com/2019/03/17/License-Utopia.html](https://writing.kemitchell.com/2019/03/17/License-Utopia.html) - [https://writing.kemitchell.com/2019/09/26/Tyranny-of-Time.html](https://writing.kemitchell.com/2019/09/26/Tyranny-of-Time.html) - https://www.smashingmagazine.com/2010/03/a-short-guide-to-open-source-and-similar-licenses/ - https://itsfoss.com/open-source-licenses-explained/ - https://choosealicense.com/ ## Ratification [https://writing.kemitchell.com/2017/08/31/Null-Value.html](https://writing.kemitchell.com/2017/08/31/Null-Value.html) ## Strategy https://coss.media/open-source-creator-licensing-fundamentals/ https://coss.media/how-to-choose-open-source-license/ https://coss.media/understand-distribution-open-source-licensing/ https://dirkriehle.com/publications/2009-selected/the-commercial-open-source-business-model/ https://dirkriehle.com/wp-content/uploads/2020/04/09062364.pdf https://dirkriehle.com/2019/12/17/single-vendor-open-source-firms-and-intellectual-property-strategies-video/ ## Ethical Licensing [https://ethicalsource.dev/definition/](https://ethicalsource.dev/definition/) https://firstdonoharm.dev/ https://heathermeeker.com/2019/11/09/good-and-not-evil-the-advent-of-ethos-licensing/ https://writing.kemitchell.com/2019/11/09/Heather-Meeker-Ethos.html --- # Appendix ## Changelog ### v0.1 First batch of reading material made publicly available for crowd-powered editing. ## Roadmap - Better guiding text in between articles. - Brief summary of each piece. - Fast track and a scenic route.

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

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

    This team is disabled

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

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

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

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

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

    Create a note from template

    Create a note from template

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

    Create a template

    Upgrade

    Delete template

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

    This page need refresh

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

    Sign in

    Forgot password

    or

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

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

    New to HackMD? Sign up

    Help

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

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

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

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

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

    Feedback

    Submission failed, please try again

    Thanks for your support.

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

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

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

        Link with GitHub

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

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

          Authorize again
         

        Choose which file to push to

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

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

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

        Syncing

        Push failed

        Push successfully