Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
Already on GitHub? Sign in to your account
Dev Docs: Add Inline Template Plugin And Use It For RPC/REST #758
Conversation
harding
added some commits
Feb 20, 2015
harding
added
the
Dev Docs
label
Feb 20, 2015
|
@harding Untested LGTM, thanks! Did you test using plain HTML to see if it works fine with a colspan? I wonder if autocrossref links would still apply fine within tables? |
|
@saivann thanks! (Reply under the announcement below.) In the absence of critical feedback, this will be merged in about 48 hours. (00:00 UTC Monday)
Here's what this quick commit renders as (note the autoxref links): Note that I haven't added any CSS, so that's the default table style. (I just realized the Kramdown-created tables use thead and tbody, but my table doesn't, which is why it looks different from the other tables in the docs. I'll fix that and make other changes.) I do have to say that editing a Liquid template is a heck of a lot easier than messing around with advanced CSS features, so I think this plugin really is the way to go. Thanks for pushing me to do better on #757! |
|
@harding That all sounds excellent and clean to me!! Thanks for taking time to find the ideal solution - this can become quite hard over time. I've also played with flexbox a little in the past and found it pretty great, the persisting lack of browser support has always been the main blocking issue. I am glad to see it's almost an issue of the past though. |

harding commentedFeb 20, 2015
This pull adds a new plugin that allows converting inline YAML to output formatted by a standard Liquid template. This pull also reformats the RPC/REST API tables to YAML and then uses a template to create the exact same tables as before. This is verified: diffing the site built on master HEAD against the site built on this final commit shows zero changes.
(No preview provided for the above reason.)
This backend code should make it easier to implement alternative table layouts as discussed in pull #757.
The YAML input for a table looks like this, with n, t, p, and d standing for name, type, presence, and description in the output table.
The first commit in this pull adds the plugin and the template, and also adds some necessary newlines to the vars.md file. The second commit just runs the sed script provided in its commit message.