Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] update versions #443

Closed
wants to merge 1 commit into from
Closed

[WIP] update versions #443

wants to merge 1 commit into from

Conversation

lrytz
Copy link
Member

@lrytz lrytz commented Jul 4, 2016

Uses the github-pages gem, see https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/

Issues I see so far:

When running bundle exec jekyll serve, accessing the main site logs [2016-07-04 12:01:48] ERROR '/resources/img/[email protected]' not found.

Pages that have a permalink not ending in / or .html are not served under bundle exec jekyll serve, but chrome downloads them. Example: https://github.com/scala/scala-lang/blob/master/news/_posts/2016-06-29-release-notes-2.12.0-M5.md. If I understand the Jekyll doc correctly, that should not happen.. https://jekyllrb.com/docs/permalinks/#extensionless-permalinks

Running bundle install for the first time, you might hit sparklemotion/nokogiri#1445. Running xcode-select --install helps.

Another Issue I see is that the follwing markdown

Hi
  - item

does not render as a bullet-list, an empty line is needed before the list. On GitHub (comments, issues, gists) this is not the case, the above would render as a bullet.

This is not related to our site in any way, it seems to be the case in general. I created a small test site here:

I contacted GitHub support about this, we'll see.

@lrytz
Copy link
Member Author

lrytz commented Jul 4, 2016

updated description.

@lrytz
Copy link
Member Author

lrytz commented Jul 6, 2016

Here's an answer from GitHub support. My question was: on GitHub, the following renders as a bullet:

Para
  - bullet

But not when using kramdown in GFM (Github Flavored Markdown) mode, then the line continues ("Para - bullet"). Here's the answer:

I'm sorry that didn't solve the problem. It turns out kramdown doesn't support that part of GitHub Flavour Markdown the way I'd hoped. It looks like you'll need to add a new line before those bullets to get the correct output in kramdown.

I checked on karmdown's issue tracker, it looks like they don't want to fix this: gettalong/kramdown#336.

So it seems GitHub is using their own markdown parser and we won't be able to get full compatibility.

@heathermiller
Copy link
Member

Oh no, that's not very nice news at all, especially given the fact that GitHub pages appears to use kramdown as the markdown parser there, so one would think they also used it elsewhere too. I guess not.

Thanks for tracking this one down – I was really hoping it's something that would be resolved by merely updating the Gemfile :/

@heathermiller
Copy link
Member

For what it's worth, I prototype documents in Typora, a nice markdown editor that renders styling as you type. When you save, it's a valid markdown file that always renders (so far, for me) in Jekyll and all over GitHub.

It also has a nice full-screen distraction-free mode. I know this isn't a fix, but maybe it helps someones' day-to-day workflow?

@lrytz
Copy link
Member Author

lrytz commented Jul 6, 2016

the ticket got re-opened - now we just need to write some ruby :)

@soc
Copy link
Contributor

soc commented Jul 23, 2016

@lrytz Before you waste time wondering why things like events are not displayed anymore after the Jeykll update: https://github.com/soc/scala-lang/blob/gh-pages/_config.yml#L14

Edit: Oh, nevermind, just saw that @fsalvi already fixed it in 2c5a583.

@SethTisue
Copy link
Member

@lrytz should some version of this be merged?

@lrytz
Copy link
Member Author

lrytz commented Oct 18, 2016

it cannot, i think it would also require updates on the epfl server. i don't time to follow up on this issue now.

another issue was that kramdown was not actually implementing the same markdown as github, maybe things improved since: gettalong/kramdown#336

@fsalvi
Copy link
Contributor

fsalvi commented Oct 18, 2016

FYI, here are the versions on the web server:
$ jekyll -v
jekyll 3.1.6
$ kramdown -v
1.11.1

@Blaisorblade
Copy link

@fsalvi that is, the webserver uses much newer versions than in our Gemfile config, and those even support incremental builds (which take 1 second rather than ~1 minute)? Or is the webserver in fact using bundler?

@jarrodu
Copy link
Member

jarrodu commented Oct 22, 2016

I suggest that the server use Bundler if it is not already and respect the Gemfile/Gemfile.lock in the repository.

Of course I also suggest updating our Gemfile after we know that it is being used by the server.

@jarrodu
Copy link
Member

jarrodu commented Oct 22, 2016

Maybe this issue should be reopend?

@SethTisue
Copy link
Member

I've opened a new ticket at #498

@fsalvi
Copy link
Contributor

fsalvi commented Nov 3, 2016

The website is now using bundler with jekyll v3.1.6 and kramdown v1.11.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants