diff options
Diffstat (limited to 'public/docs')
| -rw-r--r-- | public/docs/features.md | 11 | ||||
| -rw-r--r-- | public/docs/release-notes.md | 105 |
2 files changed, 103 insertions, 13 deletions
diff --git a/public/docs/features.md b/public/docs/features.md index 01340fd7..dc6ddafa 100644 --- a/public/docs/features.md +++ b/public/docs/features.md @@ -8,7 +8,7 @@ This means that you can write notes with other people on your **desktop**, **tab You can sign-in via multiple auth providers like **Facebook**, **Twitter**, **GitHub** and many more on the [_homepage_](/). If you experience any _issues_, feel free to report it on [**GitHub**](https://github.com/hackmdio/hackmd/issues). -Or meet us on [**Gitter**](https://gitter.im/hackmdio/hackmd) for dev-talk and interactive help. +Or meet us on [**Matrix.org**](https://riot.im/app/#/room/#hackmd:matrix.org) or [**Gitter**](https://gitter.im/hackmdio/hackmd) for dev-talk and interactive help. **Thank you very much!** Workspace @@ -25,11 +25,16 @@ Workspace <i class="fa fa-toggle-on fa-fw"></i> View: See only the result. <i class="fa fa-toggle-off fa-fw"></i> Edit: See only the editor. +## Night Mode: +When you are tired of a white screen and like a night mode, click on the little moon <i class="fa fa-moon-o"></i> and turn on the night view of HackMD. + +The editor view, which is in night mode by default, can also be toggled between night and day view using the the little sun<i class="fa fa-sun-o fa-fw"></i>. + ## Image Upload: You can upload an image simply by clicking on the camera button <i class="fa fa-camera"></i>. Alternatively, you can **drag-n-drop** an image into the editor. Even **pasting** images is possible! -This will automatically upload the image to **[imgur](http://imgur.com)**, nothing to worry. :tada: - +This will automatically upload the image to **[imgur](http://imgur.com)**, **[Amazon S3](https://aws.amazon.com/s3/)**, **[Minio](https://minio.io)** or **local filesystem**, nothing to worry about. :tada: + ## Share Notes: If you want to share an **editable** note, just copy the URL. diff --git a/public/docs/release-notes.md b/public/docs/release-notes.md index 70510b19..891c506a 100644 --- a/public/docs/release-notes.md +++ b/public/docs/release-notes.md @@ -1,6 +1,91 @@ Release Notes === +<i class="fa fa-tag"></i> 1.1.1-ce <i class="fa fa-clock-o"></i> 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) + +<i class="fa fa-tag"></i> 1.1.0-ce <i class="fa fa-clock-o"></i> 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) + <i class="fa fa-tag"></i> 1.0.1-ce <i class="fa fa-clock-o"></i> 2018-01-19 15:00 --- @@ -46,7 +131,7 @@ Release Notes * Fix mermaid compatiblity with new version * Fix SSL CA path parsing -### Refactor +### Refactors * Refactor main page * Refactor status pages * Refactor config handling @@ -182,7 +267,7 @@ Release Notes * Fix client socket on delete event might not delete corresponding history record correctly * Fix to handle name or color is undefined error * Fix history item event not bind properly on pagination change -* Fix history time should save in UNIX timestamp to avoid time offset issue +* Fix history time should save in UNIX timestamp to avoid time offset issue ### Removes - Drop bower the package manager @@ -230,16 +315,16 @@ Release Notes ### Fixes * Fix README and features document format and grammar issues * Fix some potential memory leaks bugs -* Fix history storage might not fallback correctly +* Fix history storage might not fallback correctly * Fix to make mathjax expression display in editor correctly (not italic) -* Fix note title might have unstriped html tags +* Fix note title might have unstriped html tags * Fix client reconnect should resend last operation * Fix a bug when setting both maxAge and expires may cause user can't signin * Fix text complete extra tags for blockquote and referrals * Fix bug that when window close will make ajax fail and cause cookies set to wrong state * Fix markdown render might fall into regex infinite loop -* Fix syntax error caused by element contain special characters -* Fix reference error caused by some scripts loading order +* Fix syntax error caused by element contain special characters +* Fix reference error caused by some scripts loading order * Fix ToC id naming to avoid possible overlap with user ToC * Fix header nav bar rwd detect element should use div tag or it might glitch the layout * Fix textcomplete of extra tags for blockquote not match space character in the between @@ -279,7 +364,7 @@ Release Notes ### Fixes * Workaround vim mode might overwrite copy keyMap on Windows * Fix TOC might not update after changeMode -* Workaround slide mode gets glitch and blurry text on Firefox 47+ +* Workaround slide mode gets glitch and blurry text on Firefox 47+ * Fix idle.js not change isAway property on onAway and onAwayBack events * Fix http body request entity too large issue * Fix google-diff-match-patch encodeURI exception issue @@ -287,8 +372,8 @@ Release Notes * Fix spellcheck settings from cookies might not a boolean in string type * Fix cookies might not in boolean type cause page refresh loop * Fix the signin and logout redirect url might be empty -* Fix realtime might not clear or remove invalid sockets in queue -* Fix slide not refresh layout on ajax item loaded +* Fix realtime might not clear or remove invalid sockets in queue +* Fix slide not refresh layout on ajax item loaded * Fix retryOnDisconnect not clean up after reconnected * Fix some potential memory leaks @@ -342,7 +427,7 @@ Release Notes * Support maintenance mode and gracefully exit process on signal * Update to update doc in db when doc in filesystem have newer modified time * Update to replace animation acceleration library from gsap to velocity -* Support image syntax with size +* Support image syntax with size * Update textcomplete rules to support more conditions * Update to use bigger user profile image * Support showing signin button only when needed |