Build textile to html - #4
Merged
Merged
Conversation
…les seems to be four spaces.
…microsite from textile sources.
Contributor
Author
|
Obsolete Comment: |
Signed-off-by: Lewis Marshall <lewis.marshall@ably.com>
…to RedCloth for rendering.
I'm intentionally leaving the layout otherwise fully fluid. There is no need for an arbitrary limit to rendering width, as most users of this kind of documentation will prefer to size their browser view of this content to a width that works for them.
This had me puzzled for longer than I should admit.
That was fun... one side effect was for lists - each item was starting a brand new list in HTML form.
QuintinWillison
marked this pull request as ready for review
October 2, 2022 17:54
QuintinWillison
requested review from
lmars,
mattheworiordan,
owenpearson and
stmoreau
October 2, 2022 17:55
lmars
approved these changes
Oct 3, 2022
# Conflicts: # .tool-versions
SimonWoolf
pushed a commit
that referenced
this pull request
Jan 6, 2025
[EDX-168] - Channel class descriptions
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
3 participants
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.
We need the Textile source files rendered for preview and consumption by client library developers.
For the time being I've made the decision not to convert any of the textile files to a more modern and friendly format like markdown. This is mainly because it's useful to keep the rich Git commit history currently visible against the textile files (as duplicated over from the
ably/docsrepository).I'm also trying to keep this build as simple and self-contained as possible, with minimal reliance on bigger frameworks or many other dependencies. Therefore, pulling this together with just a basic Handlebars implementation fed with output from Redcloth feels appropriate and maintainable. Plus, Tailwind CSS for styling, which is most sensibly deployed natively using Node.js - so, using
npmto run things, which makes sense (calling down to Ruby scripts when required).Use the View deployment button on this pull request to see the rendered result.