Add Sanctuary Reader to the tool directory - #293
Open
nykel wants to merge 1 commit into
Open
Conversation
Adds _tools/sanctuary-reader.md, an icon and a screenshot. The syntax support table was filled in by testing each element in the application.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds Sanctuary Reader to the Markdown tool directory. Built by duplicating
_tools/dillinger.mdand working from it, per the wiki.Files added (nothing else is touched):
_tools/sanctuary-reader.mdassets/images/tool-icons/sanctuary-reader.png— 512×512, transparent backgroundassets/images/tools/sanctuary-reader.png— screenshot of the editor with a document loadedThe support table was verified element by element in the application — none of it was copied from another tool's page. I pasted a test document for each of the 28 elements into the live editor and inspected the rendered output before choosing a value. That turned up three results worth flagging, since they are the ones a reader is most likely to be surprised by:
Partial, notYes. Inline and block-level HTML render, butscript,iframeand embedded media are removed, andclassandstyleattributes are stripped by the sanitizer.Partial. They render, but anything loaded from another domain is replaced with a notice instead of being fetched.Partial. They are generated in the full reader, where they anchor the outline, but{#custom-id}is not honoured.I also added a note to
subscript: it isNo, and the single tildes are consumed as strikethrough, soH~2~Ocomes out as H2O rather than as literal text. That seemed more useful than a bare "No".The description was kept to 83 characters so it fits the box on the directory homepage — the longest one currently in
_toolsis 91.One thing I could not check locally: I don't have Ruby on this machine, so I wasn't able to run
bundle exec jekyll serveto preview the page. I validated the front matter against_data/tools.ymland_data/status.ymlinstead — all 28 IDs exist, everyavailablevalue is one of the defined statuses, and the elements are in the same order as the model page so the table reads consistently with the rest of the directory.Happy to change the wording, the screenshot or any of the table values if you'd like something different.