blacklight/scribe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
scribe/CHANGELOG

172 lines
2.8 KiB
Text
Raw Normal View History

Update CHANGELOG
2023-05-06 19:18:13 +02:00
2023-05-06
* Upgrade to Lucky framework 1.0.0
* Upgrade to Crystal version 1.8.1
* If embedded media has a caption, it will now be displayed
2023-03-25
* Headings now have an ID so readers can link to a part if an article
* If a URL contains `global-identity-2`, Scribe will now correctly parse the article ID.
2022-11-06
* Fix viewing articles if the URL has a trailing slash
* Update to nodejs 16.18.0
Version 2022-10-30
2022-11-04 23:25:14 +01:00
2022-10-30
Update to nodejs 16.18.0 It was pretty old, but also it wasn't installing correctly on an Apple Silicon machine.
2022-11-06 23:33:20 +01:00
* Update to nodejs 16.18.0
2022-10-30
* Fix viewing articles if the URL has a trailing slash
Version 2022-10-30
2022-11-04 23:25:14 +01:00
Updates to pre/code config This ensures that code blocks look good at all screen sizes.
2022-10-12 02:33:18 +02:00
2022-10-11
* Don't clip gist contents (CSS fix)
Replace Redirector extension with LibRedirect Since Scribe launched, the Redirector extension config has needed occasional attention. Using regular expressions to cover all edge cases is difficult. After finding out that Scribe's current config can hang websites, I decided that [LibRedirect] is likely a more robust solution. It can rely on more than regular expressions, and is less work to set up. [LibRedirect]: https://libredirect.github.io/
2022-09-24 21:08:54 +02:00
2022-09-24
* Replace Redirector extension with LibRedirect
Remove downloadable Redirector config
2022-09-24 21:59:37 +02:00
* Remove downloadable Redirector config
Replace Redirector extension with LibRedirect Since Scribe launched, the Redirector extension config has needed occasional attention. Using regular expressions to cover all edge cases is difficult. After finding out that Scribe's current config can hang websites, I decided that [LibRedirect] is likely a more robust solution. It can rely on more than regular expressions, and is less work to set up. [LibRedirect]: https://libredirect.github.io/
2022-09-24 21:08:54 +02:00
Fix Redirector config escaped strings When printing out the configuration JSON, the Redirector extension expects regex escapes to be escaped, themselves. So `\` becomes `\\`. However, Crystal treats these as escaped character also, and each `\` must additionally be escaped, so a single slash becomes `\\\\`
2022-07-19 22:13:02 +02:00
2022-07-19
* Fix downloadable config file for Redirector extension
Fix source code link Capitalize the `S` in `Scribe`. I don't have record of this ever needing to be capitalized before, but it clearly does not work.
2022-07-17 17:30:03 +02:00
2022-07-17
* Fix source code link
Upgrade to Lucky 0.30.1 Upgrading to 0.31.0 should be very easy. It's just running `shards update` in the root of the project. That should be all.
2022-07-17 17:55:51 +02:00
* Upgrade to Lucky 0.30.1
Upgrade to Crystal 1.5.0
2022-07-17 18:02:01 +02:00
* Upgrade to Crystal 1.5.0
Scroll long code blocks This sets the width of code blocks to be the width of the page, and adds a scrollbar for long blocks. Article `c146e768bb41` has some examples. I could have also wrapped the codeblocks, but as pointed out by [~kaki87] this often reduces readability. Hence: scrollbars. [~kaki87]: https://todo.sr.ht/~edwardloveall/Scribe/6#event-188395
2022-07-17 19:09:34 +02:00
* Add scrollbar to long code blocks
Provide a configuration file for the Redirector extension Instead of providing long detailed instructions for how to configure the Redirector extension, this provides a single json file that users can import. I started by making a single file stored in the `public/assets` directory, but then realized this was a regression since the instructions were customized to each domain. Instead I can use Lucky's [data] response to dynamically build the JSON config. [data]: https://luckyframework.org/guides/http-and-routing/request-and-response# handling-responses
2022-07-17 20:40:02 +02:00
* Add a downloadable config file for Redirector extension
Fix source code link Capitalize the `S` in `Scribe`. I don't have record of this ever needing to be capitalized before, but it clearly does not work.
2022-07-17 17:30:03 +02:00
Update changelog to mention no DATABASE_URL
2022-05-21 21:02:06 +02:00
2022-05-21
Add support for missing posts Posts, like 8661f4724aa9, can go missing if the account or post was removed. In this case, the API returns data like this: ```json { "data": { "post": null } } ``` When this happens, we can detect it because the parsed response now has a nil value: `response.data.post == nil` and construct an `EmptyPage` instead of a `Page`. The `Articles::Show` action can then render conditionally based on if the response from `PageConverter` is a `Page` or an `EmptyPage`.
2022-06-17 19:26:35 +02:00
* Show error page for missing posts
2022-05-21
Update changelog to mention no DATABASE_URL
2022-05-21 21:02:06 +02:00
* Remove the need for a fake DATABASE_URL
Update CHANGELOG
2022-04-05 02:41:00 +02:00
2022-04-04
* Fix gist files with file extensions
Fix redirection pattern Commit 6ea0586423b13317420ecf3cf9aab10760724536 improved redirection instructions, but regressed in one way. The "Redirect to" pattern specified a slash which was accounted for in the main pattern, which resulted in a double slash: https://medium.com/@user/post-123456abcdef would redirect to https://scribe.rip//@user/post-123456abcdef This removes the extra slash
2022-03-12 17:40:04 +01:00
2022-03-12
* Fix redirection pattern
Better article ID parsing A new ArticleIdParser class takes in an HTTP::Request object and parses the article ID from it. It intentinoally fails on tag, user, and search pages and attempts to only catch articles.
2022-02-13 16:08:16 +01:00
2022-02-13
* Better article ID parsing
Link to full Medium URL on error page Previously the link on the error page was only linking to the path component of the url, e.g. `/search` but ignoring any query params e.g. `/search?q=hello`. This uses the HTTP::Request `resource` method which appears to capture both.
2022-02-13 16:11:45 +01:00
* Link to full Medium URL on error page
Fix article ID parsing bug Since the article ID regular expression wasn't anchored to the end of the URL, it would grab characters after a / or - that were hex characters. For example /@user/bacon-123abc would just grab `bac`. Not great. This anchors the ID at the end of the string so that it will be more likely to catch IDs.
2022-02-14 03:07:50 +01:00
* Fix article ID parsing bug
Better article ID parsing A new ArticleIdParser class takes in an HTTP::Request object and parses the article ID from it. It intentinoally fails on tag, user, and search pages and attempts to only catch articles.
2022-02-13 16:08:16 +01:00
Better error pages Instead of showing the default Lucky error page, the styles now match Scribe. In addition, if a URL can't be parsed, Scribe gives some information as to why this might be (that Scribe can only deal with an article pages)
2022-02-12 23:56:36 +01:00
2022-02-12
* Error page matches Scribe styles
* New error page for not being able to parse article URL
Fix markup errors caused by UTF-16/8 differences Medium uses UTF-16 character offsets (likely to make it easier to parse in JavaScript) but Crystal uses UTF-8. Converting strings to UTF-16 to do offset calculation then back to UFT-8 fixes some markup bugs. --- Medium calculates markup offsets using UTF-16 encoding. Some characters like Emoji are count as multiple bytes which affects those offsets. For example in UTF-16 💸 is worth two bytes, but Crystal strings only count it as one. This is a problem for markup generation because it can offset the markup and even cause out-of-range errors. Take the following example: 💸💸! Imagine that `!` was bold but the emoji isn't. For Crystal, this starts at char index 2, end at char index 3. Medium's markup will say markup goes from character 4 to 5. In a 3 character string like this, trying to access character range 4...5 is an error because 5 is already out of bounds. My theory is that this is meant to be compatible with JavaScript's string length calculations, as Medium is primarily a platform built for the web: ```js "a".length // 1 "💸".length // 2 "👩‍❤️‍💋‍👩".length // 11 ``` To get these same numbers in Crystal strings must be converted to UTF-16: ```crystal "a".to_utf16.size # 1 "💸".to_utf16.size # 2 "👩‍❤️‍💋‍👩".to_utf16.size # 11 ``` The MarkupConverter now converts text into UFT-16 byte arrays on initialization. Once it's figured out the range of bytes needed for each piece of markup, it converts it back into UTF-8 strings.
2022-01-30 17:47:08 +01:00
2022-01-30
* Fix bug in markup generation for text with multiple codepoints
Provide a list of instances as JSON This is for extensions or other tools that wish to have a list of instances. It can be accessed by visiting the raw file on sourcehut: https://git.sr.ht/~edwardloveall/scribe/blob/main/docs/instances.json
2022-01-29 18:58:08 +01:00
2022-01-29
* Provide list of instances as JSON file
2022-01-23
Add CHANGELOG
2022-01-23 21:06:01 +01:00
* Proxy GitHub gists with rate limiting
* Add CHANGELOG
Provide a list of instances as JSON This is for extensions or other tools that wish to have a list of instances. It can be accessed by visiting the raw file on sourcehut: https://git.sr.ht/~edwardloveall/scribe/blob/main/docs/instances.json
2022-01-29 18:58:08 +01:00
2022-01-16
Add CHANGELOG
2022-01-23 21:06:01 +01:00
* Add scribe.bus-hit.me instance
Provide a list of instances as JSON This is for extensions or other tools that wish to have a list of instances. It can be accessed by visiting the raw file on sourcehut: https://git.sr.ht/~edwardloveall/scribe/blob/main/docs/instances.json
2022-01-29 18:58:08 +01:00
2022-01-15
Add CHANGELOG
2022-01-23 21:06:01 +01:00
* Add instructions for Lucky config variables
* Ensure that scr/version is up-to-date when building
Provide a list of instances as JSON This is for extensions or other tools that wish to have a list of instances. It can be accessed by visiting the raw file on sourcehut: https://git.sr.ht/~edwardloveall/scribe/blob/main/docs/instances.json
2022-01-29 18:58:08 +01:00
2022-01-08
Add CHANGELOG
2022-01-23 21:06:01 +01:00
* Use FAQ entry to explain custom domains
Provide a list of instances as JSON This is for extensions or other tools that wish to have a list of instances. It can be accessed by visiting the raw file on sourcehut: https://git.sr.ht/~edwardloveall/scribe/blob/main/docs/instances.json
2022-01-29 18:58:08 +01:00
2022-01-04
Add CHANGELOG
2022-01-23 21:06:01 +01:00
* Improve Redirector extension instructions
* Home page instructions for custom domains
* Add visible version
2021-12-16
* update crystal version in Dockerfile
2021-12-12
* Upgrade Crystal to 1.2.1 and Lucky to 0.29.0
2021-12-04
* Add FAQ on how to use Scribe with custom domains
2021-11-20
* Add citizen4.eu instance
* Update readme
2021-11-11
* Add instance docs
2021-11-07
* Add project goals to README
2021-11-06
* Support null image widths and heights
2021-10-23
* Add FAQ
2021-10-20
* Add SECTION_CAPTION paragraph type
* Support null text on paragraphs
2021-10-16
* Parsing Fix: Add H2 Paragraph type
* Add Dockerfile
* Point source link at sr.ht project page
2021-10-15
* Further improve proposed pattern for Redirector
* Add support for development with Nix
2021-10-14
* Use app_domain in Redirector example
* Add mailing list for patches to README
2021-10-12
* Improve proposed pattern for Redirector extension
2021-10-11
* README updates
* Support medium's redirectUrl query param
* Homepage Example
2021-10-03
* Initial release
Reference in a new issue Copy permalink