First pass at Jekyll-ization #383
Conversation
Note: All content should be ported over, but there is a Maruku bug preventing the Table of Contents from rendering in the sidebar.
| @@ -10,9 +14,9 @@ Data on bills in Congress goes back to 2009, and comes from a mix of sources: | |||
|
|
|||
| All requests require a valid [API key](index.html#parameters/api-key), and use the domain: | |||
|
|
|||
| ```text | |||
| {% highlight text %} | |||
There was a problem hiding this comment.
Why the highlight tag and not the GFM syntax for syntax highlighting? I really like the ```.
There was a problem hiding this comment.
You and me both. 😄
There's a maruku bug which prevents fenced code blocks from being properly rendered. There are three options:
- Reformat code blocks
- Switch to a different markdown renderer (which Jekyll supports), e.g., rdiscount or kramdown
- Use Pygments
I went with 3, just because it was the fastest / cleanest for a first pass, but switching rendering engines (configurable via _config.yml) until things are fixed upstream may make more sense. I believe Kramdown has Table of Contents support, but when I tested, the css on the code blocks was a bit wonky.
|
Wow man, well this is unnecessarily amazingly helpful of you to do this. I admit to being inexperienced with Jekyll, so your tutelage is appreciated. I'll merge this and give it a shot. |
|
Ha. Took 30 seconds. As the body of the PR noted, there's a bug which breaks the table of contents, but working on figuring out a work around. Glad to help out any time. |
|
I saw that - but forgot that merging automatically regenerates. So I've broken the docs. :) I'll revert for now, but will re-merge with the bug fix. |
|
@konklone, what's your current build "schedule"...build after every new update, or something like build once a day? |
|
Currently, I run the compile.rb script after every change I make, so it's something I have to just remember to do. In practice it's been easy to remember, but the system feels plenty wrong. :) |
|
Hey @benbalter, did you ever work out the maruku table of contents rendering bug, by any chance? We never ended up switching to this model, even though we merged the pull request, and I'd like to re-evaluate it. |
|
(Something I'd be happy to tackle on my own too - just wondering if you knew the answer offhand by now.) |
|
Have not had a chance... will take a pass next week, if not this weekend. @adelevie, any thoughts? |
|
Exams for now :( |
|
Your 🇺🇸 needs you. |
This deprecates the need for the
sourcefolder andsource/compile.rb. Upon pushing to GitHub, Pages will automatically fire Jekyll to render the templates.This is a direct port of the existing template, but note that while all content should be ported over, there is a Maruku bug preventing the Table of Contents from rendering in the sidebar for now which I'm debugging.