siawyoung / immaculate

A beautiful, fast, AMP-compliant Jekyll theme based on Tufte CSS.
https://cdn.ampproject.org/c/siawyoung.com/immaculate/
MIT License
88 stars 29 forks source link

What changes to do to compile on Github #4

Closed chsasank closed 8 years ago

chsasank commented 8 years ago

Hi, I really like the design of the website. Thanks for taking your time to port Tufte CSS to jekyll. However, one serious problem is that we will not able to use GitHub pages as the repo uses plugins.

Is there a way to work around this? May be that would be doable without AMP?

If you think doing this yourself is too much work, can you please tell me what all changes that need to be done to get it working, so that I can work on it myself.

Thanks, Sasank.

siawyoung commented 8 years ago

You can use it with Github Pages, as long as you compile the files yourself (using serve or build) and upload the compiled HTML/CSS (the entire _site directory) to Github.

chsasank commented 8 years ago

Thanks for your reply. I am doing that already, but it'd be great to have GitHub compile automatically.

siawyoung commented 8 years ago

I guess it's possible if you remove the shortcodes file. It shouldn't have any effects, except that the demo page will stop working.

chsasank commented 8 years ago

Thanks, that should work. But I still want to use your Sidenote and Image tags. Is there a way to use them as default footnote and image of markdown respectively?

siawyoung commented 8 years ago

That's not possible without hacking into kramdown, which is what Jekyll/Immaculate is using as Markdown parser. Alternatively, if you don't mind, you can just write raw HTML in your posts.

chsasank commented 8 years ago

Thanks for your time, I will do that !

siawyoung commented 8 years ago

No problem, glad I was able to help!

kimadactyl commented 8 years ago

Just hit this same problem. I fixed it another way - by using the (I think new?) ability to have the "docs" directory as the site root. Simply set "destination: docs" in your config file and enable this in the repo. Hope this helps someone else! Obv this still requires compiling locally.

screenshot from 2016-09-15 14-09-33