Skip to content

Latest commit

 

History

History
147 lines (81 loc) · 9.05 KB

codimd.md

File metadata and controls

147 lines (81 loc) · 9.05 KB

CodiMD

  • hackmdio/codimd: CodiMD - Realtime collaborative markdown notes on all platforms.

    • CodiMD lets you collaborate in real-time with markdown. Built on HackMD source code, CodiMD lets you HOST and control your team's content with speed and ease.

    CodiMD - The Open Source HackMD

    • HackMD helps developers write better documents and build active communities with open collaboration. HackMD is built with one promise - You own and control all your content:

      • You should be able to easily download all your online content at once.
      • Your content formatting should be portable as well. (That's why we choose markdown.)
      • You should be able to control your content's presentation with HTML, slide mode, or BOOK MODE.

    • With the same promise of you owning your content, CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with REDUCED FEATURES, so you can use CodiMD for your community and own your data. (See the origin of the name CodiMD.)

      少了哪些功能沒有說明 Provide a feature matrix CodiMD vs HackMD · Issue #1145 · hackmdio/codimd #ril

    • CodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for COMMERCIAL USE CASES.

      HackMD team is committed to keep CodiMD open source. All contributions are welcome!

      從 codimd/LICENSE 有提到 "Commercial use"，是可以商用的。

  • codimd/server: CodiMD - Realtime collaborative markdown notes on all platforms. #ril

    • CodiMD lets you create real-time collaborative markdown notes. You can test-drive it by visiting our CodiMD demo server.

    • It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at HackMD and NOW FORKED INTO ITS OWN ORGANISATION. A longer writeup can be read in the history doc.

  • server/history.md at master · codimd/server

    It started with HackMD

    • HackMD is the origin of this project, which was mostly developed by Max Wu and Yukai Huang. Originally, this was open source under MIT license, but was relicensed in October 2017 to be AGPLv3. At the same time, hackmd.io was founded to offer a commercial version of HackMD.

    • The AGPLv3-version was developed and released by the community, this was for a while referred to as "HackMD community edition".

      For more on the splitting of the projects, please refer to A note to our community(https://hackmd.io/c/community-news/https%3A%2F%2Fhackmd.io%2Fs%2Fr1_4j9_hZ).

      說明授權為何從 MIT 改為 AGPL 3.0，也就是 HackMD Community Edition (CE)，順勢也將推出 HackMD Enterprise Edition (EE)。

    HackMD CE became CodiMD

    • In June 2018, CodiMD was renamed from its former name "HackMD" and continued to be developed under AGPLv3 by the community. We decided to change the name to break the CONFUSION between HackMD (enterprise offering) and CodiMD (community project), as people mistook it for an OPEN CORE development model.

      不像 GitLab CE 與 EE 的關係。

      For the whole renaming story, see the issue where the renaming was discussed.

    CodiMD went independent

    • In March 2019, a discussion over licensing, governance and the future of CodiMD lead to the formation of a distinct GitHub organization. Up to that point, the community project resided in the organization of hackmdio but was for the MOST PART SELF-ORGANIZED.

    • During that DEBATE, we did not reach an agreement that would have allowed us to MOVE THE REPOSITORY, so we simply forked it. We still welcome the HackMD team as part of our community, especially since a large portion of this code base originated with them.

      For the debate that lead to this step, please refer to the governance debate and the announcement of the new repository. #ril

      未達成協議只是 fork 出來事小，問題是 CodiMD 搜尋的結果會跑出不少 demo.codimd.org 的資料，讓人搞不清楚要用哪一個。

  • HackMD Community Announcement · Issue #579 · hackmdio/codimd #ril

  • Rename the project · Issue #720 · hackmdio/codimd #ril

  • Rebrand HackMD CE to CodiMD by SISheogorath · Pull Request #850 · hackmdio/codimd #ril

安裝設置 {: #setup }

Docker

Configuration {: #config}

  • CodiMD Configuration Overview - HackMD #ril

    • You can configure CodiMD with environment variables or with config file config.json. We recommend you use ENVIRONMENT VARIABLES to configure CodiMD. config.json reserve FOR DEVELOPMENT USE ONLY.

      All environment variables you can configure are defined in ./lib/config/environment.js and overwrite .config.json.

      不確定 environment variable 指的是不是 environment.js??

    • Hint: You would find most config options duplicated in both the config file and environment variables.

      The rationale behind this architecture design is that we recommend:

      • using environment variables at any production environment
      • using the config file config.json when developing

參考資料 {: #reference }

文件：

手冊：