Release Notes - CodiMD

Release Notes === 2.4.0 Papilio maraho 2021-05-11 --- <div style="text-align: center; margin-bottom: 1em;"> <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/32/Papilio_maraho_male_ventral_view_20160423.jpg/569px-Papilio_maraho_male_ventral_view_20160423.jpg" width="600"> Papilio maraho </div> > Papilio maraho is a species of butterfly in the family Papilionidae. It is endemic to Taiwan. > \- Wikipedia [Papilio maraho](https://en.wikipedia.org/wiki/Papilio_maraho) [Check out the complete release note][v2_4_0]. Thank you CodiMD community and all our contributors. ❤️ [v2_4_0]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv2_4_0 ## Enhancements - Support autofix linter errors - Support anonymous updates via API - Support mediawiki export format in pandoc export - Add some help strings to Prometheus metrics - Allow more syntax highlight modes in editor - Support TOC level customization - Follow Google guidelines to use Google OAuth ## Fixes - Vimeo won't show up due to the jsonp callback data unable be parsed with jQuery - Fix slide mode stored XSS - Enforce PG ssl require mode on heroku - Webpack exclude path should support windows path - Free url can read any md in file system - Use encoded noteId when calling updateHistory ## Docs - Add matrix badge and links to README [#1629](https://github.com/hackmdio/codimd/pull/1629) [@a-andreyev](https://github.com/a-andreyev) 2.3.1 Isoetes taiwanensis 2021-01-04 --- ### Fixes * Upgrade mermaid to 8.6.4 to make the previous fix works 2.3.0 Isoetes taiwanensis 2020-12-30 --- <div style="text-align: center; margin-bottom: 1em;"> <img src="https://upload.wikimedia.org/wikipedia/commons/4/4a/%E5%8F%B0%E7%81%A3%E6%B0%B4%E9%9F%AD.JPG" width="600"> Isoetes taiwanensis </div> > Isoetes taiwanensis is a species of plant in the family Isoetaceae. It is endemic to Taiwan, and the only species of quillwort there. As other quillworts, it is relatively small, with erect leaves 7–24 cm (2.8–9.4 in) long. It grows submersed in shallow ponds for most of the year. IUCN considers it critically endangered because of habitat loss. > \- Wikipedia [Isoetes taiwanensis](https://en.wikipedia.org/wiki/Isoetes_taiwanensis) In this release, we focus on polishing existing features, fixing bugs and patching security issues. We continue to expand the APIs. CodiMD now supports ["Update note's content" and "delete note"](https://github.com/hackmdio/codimd/pull/1559) RESTful APIs. Thanks for the great works from [@JamesCamel](https://github.com/JamesCamel) :heart_eyes: We also fix several XSS security issues, including [mermaid](https://github.com/hackmdio/codimd/pull/1633), [vega](https://github.com/hackmdio/codimd/pull/1637) and [image lightbox](https://github.com/hackmdio/codimd/pull/1632). We appreciate the security report from [@msrkp](https://github.com/@msrkp), [@Alemmi](https://github.com/Alemmi), and [@nename0 ](https://github.com/nename0). This is the last release before the end of this year. Merry Christmas to everyone! Let's look forward and see you in the next year. :tada: [Check out the complete release note][v2_3_0]. Thank you CodiMD community and all our contributors. ❤️ [v2_3_0]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv2_3_0 ### Enhancements - Fretboard improvements - Update and delete note api - Allow Sequelize CLI to use options set in config.json - Allow specifying option for graphviz - Spellcheck: add en_GB dictionary ### Fixes - Fix ui-edit and ui-both buttons in night mode - Don't run jsonlint on .vscode jsonc files - Fix image lightbox xss issue - Fix mermaid xss issue - Check upload image mime type - Vega syntax XSS dependencies 2.2.0 Diploderma swinhonis 2020-07-20 --- <div style="text-align: center; margin-bottom: 1em;"> <img src="https://i.imgur.com/P1HXrhw.jpg" width="600"> Diploderma swinhonis </div> > Diploderma swinhonis, also known as the Taiwan japalure, Swinhoe's japalure, and Swinhoe's tree lizard, is a species of lizard in the family Agamidae. The species is endemic to Taiwan. > \- Wikipedia [Diploderma swinhonis](https://en.wikipedia.org/wiki/Diploderma_swinhonis) In this release, we've added some Markdown renderer plugins, including fretboard guitar, Mindmap, and CSV. We believe the simplicity and the extensibility of markdown can bring more possibilities to you and your workflow. So let's find out more about what we can do with markdown. :100: We also fixed a long-lasting issue: CodiMD cannot be hosted under URL subpath perfectly. Check PR [#1551](https://github.com/hackmdio/codimd/pull/1551) for details. Last but not least, we start standarizing CodiMD API. We drafted [`List my notes`](https://github.com/hackmdio/codimd/pull/1548) API in this release. Stay tuned. :person_in_lotus_position: Here are some highlights from this release: - [Fretboard Guitar tab renderer](#Fretboard-Guitar-tab-renderer) - [Mindmap rendrer](#Mindmap) - [Image Lightbox](#Image-Lightbox-Support) - [CSV renderer](#Render-csv-codeblock-as-table) [Check out the complete release note][v2_2_0]. Thank you CodiMD community and all our contributors. ❤️ [v2_2_0]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv2_2_0 ### Enhancements - Use array for tags when available - Replace btn-social with btn-login-method - Set html image meta tag with YAML metadata - List my note API ### Fixes - Update Simplified Chinese translation and fix typography - Fix webpack urlpath font loading error 2.1.0 Zhangixalus prasinatus 2020-05-18 --- <div style="text-align: center; margin-bottom: 1em;"> <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/9e/Rhacophorus_prasinatus.jpg/640px-Rhacophorus_prasinatus.jpg" width="450"> Zhangixalus prasinatus </div> > Zhangixalus prasinatus is a species of frog in the family Rhacophoridae endemic to northern Taiwan. It is the largest tree frog in Taiwan; females can reach 7 cm (2.8 in) in snout-vent length. It is known from Taipei, Yilan, and Taoyuan. > \- Wikipedia [Zhangixalus prasinatus](https://en.wikipedia.org/wiki/Zhangixalus_prasinatus) During this hard time of COVID-19, it's a pleasure to help people collaborate better with CodiMD. We hope the world will recover from this situation soon. :sunrise: Good news, we have some goodies for CodiMD including: - [Support Prometheus metrics](https://hackmd.io/@codimd/v2_1_0#Support-Prometheus-metrics) - [Cut docker image size by 57%](https://hackmd.io/@codimd/v2_1_0#Cut-docker-image-size-by-57) - [Drop Node 8 Support](https://hackmd.io/@codimd/v2_1_0#Drop-Node-8-Support) [Check out the complete release note][v2_1_0]. Thank you CodiMD community and all our contributors. ❤️ [v2_1_0]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv2_1_0 ### Enhancements - Optimize module size - Support brace wrapped param in fence lang - Upgrade Node.JS version to 10.20.1 ### Fixes - Fix getStatus caused "TypeError: Converting circular structure to JSON" 2.0.1 Urocissa caerulea 2020-04-09 --- [CodiMD 2.0.1](https://github.com/hackmdio/codimd/releases/tag/2.0.1) is a minor release fixing bugs introduced in 2.0.0 and earlier versions along with some enhancements. We encourage everyone to upgrade to 2.0.1 now. See how things are going on [GitHub](https://github.com/hackmdio/codimd/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+milestone%3ANext). Stay tuned and healthy, and we hope you love it! ### Enhancements - Allow inline markdown in spoiler summary syntax - Improve visibility of some UI elements - Support avatar for OAuth users ### Fixes - Fix to add missing configs in docker secret - Fix not able to upload image using imgur - Fix to improve version checker behavior - Fix Wikipedia link in 2.0.0 release notes - Fix require path for minio - Fix check for creating free url notes [Check out the complete release note][v2_0_1]. Thank you CodiMD community and all our contributors. ❤️ [v2_0_1]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv2_0_1 2.0.0 Urocissa caerulea 2020-03-02 --- <div style="text-align: center; margin-bottom: 1em;"> <img src="https://i.imgur.com/oRbNzRm.jpg" width="600"> Urocissa caerulea </div> > The Taiwan blue magpie (Urocissa caerulea), also called the Taiwan magpie, Formosan blue magpie , or the "long-tailed mountain lady", is a species of bird of the crow family. It is endemic to Taiwan. > > \- Wikipedia [Taiwan blue magpie](https://en.wikipedia.org/wiki/Taiwan_blue_magpie) In the past few months, we delivered not only a bunch of awesome features but also some critical bug fixes. Moreover, we refactored CodiMD's backend and started to write new tests. To make it easier to maintain, we dropped legacy code, reorganize the repository, and add new documentation. For these reasons, we decided to make a huge leap toward version 2.0.0. Here are the highlights coming from version 2.0.0: - [Multilanguage spellchecker][multilanguage-spellchecker] - [Customize editor color schemes][customize-editor-color-schemes] - [Export note with Pandoc][support-pandoc-export] - [Embed Geolocation data][embedding-geolocation-data] - [Version checking][auto-version-check-for-site-admin] - [Meet the new CodiMD CLI][meet-the-new-codimd-cli] - [Refreshed Documentation structure and new Markdown guides](refreshed-documentation-structure-and-new-markdown-guides) It's our pleasure to announce CodiMD `2.0.0`. Enjoy as always :heartpulse:. [Check out the complete release note][v2_0_0]. Thank you CodiMD community and all our contributors. ❤️ [multilanguage-spellchecker]: https://hackmd.io/@codimd/v2_0_0#Multilanguage-spellchecker [customize-editor-color-schemes]: https://hackmd.io/@codimd/v2_0_0#Customize-editor-color-schemes [support-pandoc-export]: https://hackmd.io/@codimd/v2_0_0#Support-Pandoc-export [embedding-geolocation-data]: https://hackmd.io/@codimd/v2_0_0#Embedding-Geolocation-data [auto-version-check-for-site-admin]: https://hackmd.io/@codimd/v2_0_0#Auto-version-check-for-site-admin [meet-the-new-codimd-cli]: https://hackmd.io/@codimd/v2_0_0#Meet-the-new-CodiMD-CLI [refreshed-documentation-structure-and-new-markdown-guides]: https://hackmd.io/@codimd/v2_0_0#Refreshed-Documentation-structure-and-new-Markdown-guides [v2_0_0]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv2_0_0 1.4.1 2019-12-13 --- [CodiMD 1.4.1](https://github.com/hackmdio/codimd/releases/tag/1.4.1) is a minor release including bug fixes introduced in 1.4.0 and earlier versions. We encourage everyone to upgrade to 1.4.1 now. Also, we're preparing for the next major release, and you can see how things are going on [GitHub](https://github.com/hackmdio/codimd/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+milestone%3ANext). Stay tuned, and we hope you love it! ### Fixes - Fix urlpath in webpack build - Fix mysql not bundled in package.json - Fix minio image uploading - Fix pcheck not parsed url correctly - Fix manage_users script ### Enhancement - Added Scalingo compatible deployment [Check out the complete release note][v1_4_1]. Thank you CodiMD community and all our contributors. ❤️ [v1_4_1]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv1_4_1 1.4.0 Syrmaticus mikado 2019-11-11 --- <div style="text-align: center; margin-bottom: 1em;"> <img src="https://upload.wikimedia.org/wikipedia/commons/6/60/Mikado_Pheasant_398.jpg" width="300"> Mikado Pheasant, photo credits to <a href="https://zh.wikipedia.org/wiki/File:Mikado_Pheasant_398.jpg">Snowyowls from wikipedia</a> </div> Starting from version 1.4.0, we'll pick one species from [_the endemic species of Taiwan_](https://en.wikipedia.org/wiki/List_of_endemic_species_of_Taiwan) as version name. Is there anyone still remember we've once used type of coffee as our version name? It's time to revive that good convention, but this time we don't need coffee to stay up all night. 💤 It has been over 200+ commits since our last release. These are the highlights from version 1.4.0: - [New table tools][table-tools] - Create table with auto-formatting and keyboard shortcut - [Markdownlint integration][markdownlint] - Lint you markdown document - [Support PlantUML, vega-lite renderer][more-renderers] - More renderers to come - [Support spoiler container, ruby markdown syntax][more-syntax] - [New Emoji sets][new-emoji] - [Slide mode plugins][slide-mode-plugins]: Elapsed time bar and Spotlight [Check out the complete release note][v1_4_0]. Thank you CodiMD community and all our contributors. ❤️ [table-tools]: https://hackmd.io/@codimd/v1_4_0#New-Table-Tools [markdownlint]: https://hackmd.io/@codimd/v1_4_0#Markdownlint-integration [more-renderers]: https://hackmd.io/@codimd/v1_4_0#Support-2-new-render-engines-PlantUML-and-Vega-lite [more-syntax]: https://hackmd.io/@codimd/v1_4_0#Suppport-2-New-markdown-syntax-Spoiler-and-Ruby [new-emoji]: https://hackmd.io/@codimd/v1_4_0#New-emoji-sets [slide-mode-plugins]: https://hackmd.io/@codimd/v1_4_0#Slide-mode-enhancement [v1_4_0]: https://hackmd.io/@codimd/release-notes/%2F%40codimd%2Fv1_4_0 1.3.1 2019-03-23 00:00 --- ### Enhancements * Add some missing translations * Add Serbian language ### Fixes * Fix broken redirect for empty `serverURL` * Fix wrong variable type for HSTS maxAge * Fix GitLab snippets showing up without being configured * Fix Google's API after disabling Google+ * Fix broken PDF export ### Contributors * atachibana (translator) * [Aurélien JANVIER](https://github.com/ajanvier) (translator) * [Daan Sprenkels](https://github.com/dsprenkels) (translator) * Farizrizaldy (translator) * [Luclu7](https://github.com/Luclu7) * Sylke Vicious (translator) * [toshi0123](https://github.com/toshi0123) & okochi-toshiki * [Turakar](https://github.com/Turakar) * [Vladan](https://github.com/cvladan) (translator) 1.3.0 2019-03-03 00:00 --- ### Enhancements * Run db migrations on `npm start` * Add documentation about integration with AD LDAP * Add `rel="noopener"` to all links * Add documentation about integration with Nextcloud for authentication * Update URL on frontpage to point to codimd.org * Replace Fontawesome with Forkawesome * Add OpenID support * Add print icon to slide view * Add auto-complete for language names that are highlighted in codeblocks * Improve translations for Chinese, Dutch, French, German, Italien, Korean, Polish, and Russian language * Add Download action to published document API * Add reset password feature to `manage_users` script * Move from own `./tmp` directory to system temp directory * Add Etherpad migration guide * Move XSS library to a more native position * Use full version string to determine changes from the backend * Update winston (logging library) * Use slide preview in slide example * Improve migration handling * Update reveal.js to version 3.7.0 * Replace scrypt library with its successor * Replace `to-markdown` with `turndown` (successor library) * Update socket.io * Add warning on missing base URL * Update bootstrap to version 3.4.0 * Update handlebar ### Fixes * Fix paths in GitLab documentation * Fix missing `data:` URL in CSP * Fix oAuth2 name/label field * Fix GitLab API integration * Fix auto-completed but not rendered emojis * Fix menu organization depending on enabled services * Fix some logging in the OT module * Fix some unhandled internalOAuthError exception * Fix unwanted creation of robots.txt document in "freeurl-mode" * Fix some links on index page to lead to the right sections on feature page * Fix document breaking, empty headlines * Fix wrong multiplication for HSTS header seconds * Fix wrong subdirectories in exported user data * Fix CSP for speaker notes * Fix CSP for disqus * Fix URL API usage * Fix Gist embedding * Fix upload provider error message * Fix unescaped disqus user names * Fix SAML vulnerability * Fix link to SAML guide * Fix deep dependency problem with node 6.x * Fix broken PDF export by wrong unlink call * Fix possible XSS attack in MathJax ### Refactors * Refactor to use `ws` instead of the the no longer supported `uws` * Refactor frontend build system to use webpack version 4 * Refactor file path configuration (views, uploads, …) * Refactor `manage_users` script * Refactor handling of template variables * Refactor linting to use eslint ### Removes * Remove no longer working Octicons * Remove links to our old Gitter channel * Remove unused library node-uuid * Remove unneeded blueimp-md5 dependency * Remove speakerdeck due to broken implementation ### Contributors * Adam.emts (translator) * [Alex Garcia](https://github.com/asg017) * [Cédric Couralet (micedre)](https://github.com/micedre) * [Claudius Coenen](https://github.com/ccoenen) * [Daan Sprenkels](https://github.com/dsprenkels) * [David Mehren](https://github.com/davidmehren) * [Erona](https://github.com/Eronana) * [Felix Yan](https://github.com/felixonmars) * [Jonathan](https://github.com/phrix32) * Jong-kai Yang (translator) * [MartB](https://github.com/MartB) * [Max Wu (jackycute)](https://github.com/jackycute) * [mcnesium](https://github.com/mcnesium) * Nullnine (translator) * RanoIP (translator) * [SuNbiT](https://github.com/sunbit) * Sylke Vicious (translator) * Timothee (translator) * [WilliButz](https://github.com/WilliButz) * [Xaver Maierhofer](https://github.com/xf-) * [云屿](https://github.com/cloudyu) 1.2.1 2018-09-26 00:00 --- ### Enhancements * Update Italian translations * Update Japanese translations * Update markdown-pdf * Add support for unix sockets * Update "follow us" information to Community channel and translation * Add Cloudron installation method * Add guide for Mattermost authentication * Update various packages * Add Indonesian language as new translation ### Fixes * Fix content types in status router * Fix some modal colors in night mode * Fix CSP to allow usage of speaker notes * Fix some wrong title attributes in the editor toolbar * Fix some confusion about the default location of images. It's always the local filesystem now * Fix object handling in avatar generation code * Finally fix error handling of LZ-String by using self-maintained version * Fix migration handling * Fix gitlab API version * Fix some server crashes caused by PDF creation * Fix document length limit on post to `/new` * Fix broken youtube embedding on `/features` page ### Refactors * Refactor generation of table of contents * Refactor "copyright"-section to be a "Powered by" ### Removes * Remove unneeded inline styling ### Deprecations * NodeJS version 6 * Mattermost login integration (is replaced by [generic oAuth2 module](https://github.com/hackmdio/codimd/blob/6ce7b20a7f92ccff2f7f870ff5d116d685310cfd/docs/guides/auth/mattermost-self-hosted.md)) ### Honorable mentions * [Alex Hesse (Pingu501)](https://github.com/Pingu501) * [Alexander Wellbrock (w4tsn)](https://github.com/w4tsn) * [Cédric Couralet (micedre)](https://github.com/micedre) * [Girish Ramakrishnan (gramakri)](https://github.com/gramakri) * [maahl](https://github.com/maahl) * [Max Wu (jackycute)](https://github.com/jackycute) * [Miranda (ahihi)](https://github.com/ahihi) * [Ondřej Slabý (maxer456)](https://github.com/maxer456) 1.2.0 2018-06-28 00:00 --- ### Announcement * HackMD CE is renamed to CodiMD to prevent confusion. [For details see here](https://github.com/hackmdio/codimd#hackmd-ce-became-codimd) ### Enhancements * Show full title by hovering over to table of contents entries * Add generic OAUTH2 support for authentication * Redirect unauthenticated user to login page on "forbidden" pages * Add ability to add ToS and privacy documents without code changes * Add account deletion as part of user self-management * Add download of all own notes * Add privacy policy example (no legal advice) * Increase checkbox size on slides * Add support for Azure blob storage for image uploads * Add Korean translation * Add note about official K8s chart for deployment * Add toolbar for markdown shortcuts in editor * Add ability to disable Gravatar integration * Add print icon to slide menu which leads to the print view. * Add sequelize to setup instructions * Update various packages ### Fixes * Fix local writes for non-existing translations in production * Fix wrong documentation about default image upload type * Fix possible error if CodiMD is started with wrong working directory * Fix issues caused by cached/cacheeable client config * Fix issues caused by notes created via curl/API with CRLF line endings * Fix broken images for downloaded PDFs while using `filesystem` as `imageUploadType` * Fix Unicode URLs when using `allowFreeURL=true` ### Refactors * Split auth documentation into multiple documents ### Removes * Remove polyfill for `useCDN=false` setups * Remove unused and no longer needed symlink from translations ### Honorable mentions * [Adam Hoka (ahoka)](https://github.com/ahoka) * [Edgar Z. Alvarenga (aivuk)](https://github.com/aivuk) * [Jacob Burden (jekrb)](https://github.com/jekrb) * [Pedro Ferreira (pferreir)](https://github.com/pferreir) * [TC Liu (liuderchi)](https://github.com/liuderchi) 1.1.1-ce 2018-05-23 12:00 --- ### Security * Fix Google Drive integration leaked `clientSecret` for Google integration * Update base64url package ### Fixes * Fix typos in integrations * Fix high need of file descriptors during build * Fix heroku deployment by limiting node version to <10.x ### Refactors * Refactor letterAvatars to be compliant with CSP ### Removes * Google Drive integration ### Honorable mentions * [Max Wu (jackycute)](https://github.com/jackycute) 1.1.0-ce 2018-04-06 12:00 --- ### Security * Adding CSP headers * Prevent data-leak by wrong LDAP config * Generate dynamic `sessionSecret` if none is specified ### Enhancements * Add Minio support * Allow posting content to new notes by API * Add anonymous edit function in restricted mode * Add support for more Mimetypes on S3, Minio and local filesystem uploads * Add basic CLI tooling for local user management * Add referrer policy * Add more usable HTML5 tags * Add `useridField` in LDAP config * Add option for ReportURI for CSP violations * Add persistance for night mode * Allow setting of `sessionSecret` by environment variable * Add night mode to features page * Add Riot / Matrix - Community link to help page ### Fixes * Fix ToDo-toggle function * Fix LDAP provider name in front-end * Fix errors on authenticated sessions for deleted users * Fix typo in database migration * Fix possible data truncation of authorship * Minor fixes in README.md * Allow usage of ESC-key by codemirror * Fix array of emails in LDAP * Fix type errors by environment configs * Fix error message on some file API errors * Fix minor CSS issues in night mode ### Refactors * Refactor contact * Refactor social media integration on main page * Refactor socket.io code to no longer use referrer * Refactor webpack config to need less dependencies in package.json * Refactor imageRouter for modularity * Refactor configs to be camel case ### Removes * Remove unused `tokenSecret` from LDAP config ### Deprecations * All non-camelcase config ### Honorable mentions * [Dario Ernst (Nebukadneza)](https://github.com/Nebukadneza) * [David Mehren (davidmehren)](https://github.com/davidmehren) * [Dustin Frisch (fooker)](https://github.com/fooker) * [Felix Schäfer (thegcat)](https://github.com/thegcat) * [Literallie (xxyy)](https://github.com/xxyy) * [Marc Deop (marcdeop)](https://github.com/marcdeop) * [Max Wu (jackycute)](https://github.com/jackycute) * [Robin Naundorf (senk)](https://github.com/senk) * [Stefan Bühler (stbuehler)](https://github.com/stbuehler) * [Takeaki Matsumoto (takmatsu)](https://github.com/takmatsu) * [Tang TsungYi (vazontang)](https://github.com/vazontang) * [Zearin (Zearin)](https://github.com/Zearin) 1.0.1-ce 2018-01-19 15:00 --- ### Security * Fix Dropbox client secret leak ### Enhancements * Improve version handling * It's 2018! ### Fixes * Fix image alt-tag rendering * Fix Dropbox appkey 1.0.0-ce 2018-01-18 12:00 --- ### License * Switch from MIT to AGPL ### Enhancements * Improve language support * Allow themes for reveal * Add dark theme for