Git Product home page Git Product logo

beautiful-jekyll's Introduction

Beautiful Jekyll

Gem Version

By Dean Attali · Demo

Beautiful Jekyll is a ready-to-use template to help you create a beautiful website quickly. Perfect for personal sites, blogs, or simple project websites. Check out a demo of what you'll get after just two minutes. You can also look at my personal website or my consulting website to see it in use, or see examples of websites other people created using this theme.

If you enjoy Beautiful Jekyll, please consider supporting me. You'll also gain access to office hours and more features! ❤

Table of contents

Features

Check out What's New? to see the latest features!

  • SIMPLE: The primary goal of Beautiful Jekyll is to allow literally anyone to create a website in a few minutes.
  • Modern: Uses the latest best practices and technologies to achieve nearly perfect scores on Google Chrome's Audit.
  • Mobile-first: Designed to look great on both large-screen and small-screen (mobile) devices.
  • Highly customizable: Many personalization settings such as changing the background colour/image, adding a logo.
  • Flexible usage: Use Beautiful Jekyll directly on GitHub or via a Ruby gem - choose the best development method for you.
  • Battle-tested: By using Beautiful Jekyll, you'll be joining 50,000+ users enjoying this theme since 2015.
  • SEO and social media support: Customize how your site looks on Google and when shared on social media.
  • Comments support: Add comments to any page using either Disqus, Facebook comments, Utterances, Staticman, giscus, or CommentBox.
  • Tags: Any blog post can be tagged with keywords, and an index page is automatically generated.
  • Analytics: Easily integrate Google Analytics, or other analytics platforms, to track visits to your website.
  • Search: Let users easily find any page using a Search button in the navigation bar.
  • Photos support: Any page can have a full-width cover photo and thumbnail.
  • RSS: An RSS feed is automatically created, so you can even host a podcast easily with Beautiful Jekyll.

Sponsors 🏆

Developing and maintaining Beautiful Jekyll takes a lot of time and effort - thank you to anyone who helps fund this effort!

Become a sponsor for Beautiful Jekyll and unlock new features!

Build your website in 3 steps

There are a few different ways to build a website using Beautiful Jekyll, and this document will go through the simplest one: using a fork on GitHub. For most people (including myself!), this easy method is the recommended one.

Even if you choose to use one of the advanced installation methods, I still suggest you read through the easy method first.

The easy way (recommended!)

Getting started is literally as easy as 1-2-3 😄

Scroll down to see the steps involved, but here is a 30-second video just as a reference as you work through the steps. If you don't already have a GitHub account, you'll need to sign up.

Installation steps

1. Fork this project

Click on the Fork button at the top right corner of this page. Forking means that you're copying this entire project and all its files into your account. Do not click on the Create fork button on the next page yet.

2. Rename the repository to YOURUSERNAME.github.io

You'll see the word "repository" used a lot in GitHub - it simply means "project". Under Repository name you should see the name beautiful-jekyll, this is where you need to rename your project to YOURUSERNAME.github.io (replace YOURUSERNAME with your GitHub user name). It's important to use this exact name so that GitHub will recognize it and automatically create a website for this project.

Tip: If you want to use a different URL for your website, check out the FAQ

3. Customize your website settings

Edit the _config.yml file to change any settings you want. To edit the file, first click on it to view the file, and on the next page click on the pencil icon to edit it (watch the video tutorial above if you're confused). The settings in the file are self-explanatory and there are comments inside the file to help you understand what each setting does. Any line that begins with a hashtag (#) is a comment, and the other lines are actual settings. After changing the settings, click the green Commit changes button to save these edits.

Note: In the video above, only one setting in the _config.yml file is edited, but you should go through the rest of the settings as well.

4. Congratulations! You have a website!

If you named your project correctly and made an edit to the config file, your website should be ready in a minute or two at https://YOURUSERNAME.github.io. Every time you make a change to any file, your website will get rebuilt and should be updated in about a minute or so. Your website will be initialized with several sample blog posts and a couple other pages.

The harder way (for advanced users)

The instructions above explain how to use Beautiful Jekyll in the easiest way: by forking on GitHub. There are more advanced installation methods that include either using GitHub Pages with remote themes, or using Ruby gems. They provide you with more control, but are only intended for advanced users.

Note: Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you use this theme via Ruby gems.

Plans

Beautiful Jekyll is, and always will be, free. But if you want to remove the Beautiful Jekyll ad from your website, use a Dark Mode skin, access office hours, or simply support the development efforts, check out the different plans.

Add your own content

To add pages to your site, you can either write a markdown file (.md) or you can write an HTML file. It's much easier to write markdown than HTML, so that's the recommended approach (here's a great tutorial if you need to learn markdown in 5 minutes).

To see an example of a markdown file, click on any file that ends in .md, for example aboutme.md. On that page you can see some nicely formatted text (there's a word in bold, a link, a few bullet points), and if you click on the pencil icon to edit the file, you'll see the markdown code that generated the pretty text. Very easy!

In contrast, look at tags.html. That's how your write HTML - not as pretty. So stick with markdown if you don't know HTML.

Any markdown or HTML file that you create will be available on your website under https://<yourusername>.github.io/<pagename>. For example, if you create a file about.md (or about.html) then it'll exist at https://<yourusername>.github.io/about.

Files you create inside the _posts directory will be treated as blog entries. You can look at the existing files there to get an idea of how to write blog posts. Note the format of the blog post files - they must follow the naming convention of YEAR-MONTH-DAY-title.md. After you successfully add your own post, you can delete the existing files inside _posts to remove the sample posts, as those are just demo posts to help you learn.

Customizing parameters for each page

One last important thing: In order to have your new pages use this template and not just be plain HTML pages, you must add YAML front matter to the top of each page:

---
---

This is where you'll be able to give each page some extra parameters (such as a title, a subtitle, an image, etc - below is a list of all parameters). Add any parameters you want between these two dashed lines, for example:

---
title: Contact me
subtitle: Here you'll find all the ways to get in touch with me
---

If you don't want to use any parameters on a page, you still need to use the two dashed lines. If you don't, then your file will be shown as-is without the Beautiful Jekyll template.

You can look at the top of aboutme.md as an example.

Important takeaway: ALWAYS add the YAML front matter, which is two lines of three dashes, to EVERY page. If you have any parameters, they go between the two lines.

Supported parameters

Below is a list of the parameters that Beautiful Jekyll supports (any of these can be added to the YAML front matter of any page). Remember to also look in the _config.yml file to see additional site-wide settings. If there's a parameter that you want to apply to the entire site instead of one specific page, check out this FAQ answer.

Main parameters

These are the basic YAML parameters that you are most likely to use on most pages.

Parameter Description
title Page or blog post title
subtitle Short description of page or blog post that goes under the title
tags List of tags to categorize the post. Separate the tags with commas and place them inside square brackets. Example: [personal, analysis, finance]
cover-img Include a large full-width image at the top of the page. You can either provide the path to a single image (eg. "/path/to/img") , or a list of images to cycle through (eg. ["/path/img1", "/path/img2"]). If you want to add a caption to an image, then you must use the list notation (use [] even if you have only one image), and each image should be provided as "/path/to/img" : "Caption of image".
thumbnail-img For blog posts, if you want to add a thumbnail that will show up in the feed, use thumbnail-img: /path/to/image. If no thumbnail is provided, then cover-img will be used as the thumbnail. You can use thumbnail-img: "" to disable a thumbnail.
comments If you want do add comments to a specific page, use comments: true. Comments only work if you enable one of the comments providers (Facebook, disqus, staticman, utterances, giscus, CommentBox) in _config.yml file. Comments are automatically enabled on blog posts but not on other pages; to turn comments off for a specific post, use comments: false.
mathjax If you want to use LaTeX formulas, you need to enable MathJax. Note that in MathJax you need to use $$ and \\( to start and end expressions

Parameters for SEO and social media sharing

These parameters let you control what information shows up when a page is shown in a search engine (such as Google) or gets shared on social media (such as Twitter/Facebook).

Parameter Description
share-title A title for the page. If not provided, then title will be used, and if that's missing then the site title (from _config.yml) is used.
share-description A brief description of the page. If not provided, then subtitle will be used, and if that's missing then an excerpt from the page content is used.
share-img The image to show. If not provided, then cover-img or thumbnail-img will be used if one of them is provided.

Less commonly used parameters

These are parameters that you may not use often, but can come in handy sometimes.

Parameter Description
author Specify the author of a blog post (useful if a website has multiple authors).
readtime If you want a post to show how many minutes it will take to read it, use readtime: true.
show-avatar If you have an avatar configured in the _config.yml but you want to turn it off on a specific page, use show-avatar: false.
social-share By default, every blog post has buttons to share the page on social media. If you want to turn this feature off, use social-share: false.
nav-short By default, the navigation bar gets shorter after scrolling down the page. If you want the navigation bar to always be short on a certain page, use nav-short: true
gh-repo If you want to show GitHub buttons at the top of a post, this sets the GitHub repo name (eg. daattali/beautiful-jekyll). You must also use the gh-badge parameter to specify what buttons to show.
gh-badge Select which GitHub buttons to display. Available options are: [star, watch, fork, follow]. You must also use the gh-repo parameter to specify the GitHub repo.
last-updated If you want to show that a blog post was updated after it was originally released, you can specify an "Updated on" date.
layout What type of page this is (default is post for blog posts and page for other pages). See Page types section below for more information.

Advanced parameters

These are advanced parameters that are only useful for people who need very fine control over their website.

Parameter Description
footer-extra If you want to include extra content below the social media icons in the footer, create an HTML file in the _includes/ folder (for example _includes/myinfo.html) and set footer-extra to the name of the file (for example footer-extra: myinfo.html). Accepts a single file or a list of files.
before-content Similar to footer-extra, but used for including HTML before the main content of the page (below the title).
after-content Similar to footer-extra, but used for including HTML after the main content of the page (above the footer).
head-extra Similar to footer-extra, but used if you have any HTML code that needs to be included in the <head> tag of the page.
language HTML language code to be set on the page's <html> element.
full-width By default, page content is constrained to a standard width. Use full-width: true to allow the content to span the entire width of the window.
js List of local JavaScript files to include in the page (eg. /assets/js/mypage.js)
ext-js List of external JavaScript files to include in the page (eg. //cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js). External JavaScript files that support Subresource Integrity (SRI) can be specified using the href and sri parameters eg.
href: "//code.jquery.com/jquery-3.1.1.min.js"
sri: "sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8="
css List of local CSS files to include in the page
ext-css List of external CSS files to include in the page. External CSS files using SRI (see ext-js parameter) are also supported.

Page types

  • post - To write a blog post, add a markdown or HTML file in the _posts folder. As long as you give it YAML front matter (the two lines of three dashes), it will automatically be rendered like a blog post. Look at the existing blog post files to see examples of how to use YAML parameters in blog posts.
  • page - Any page outside the _posts folder that uses YAML front matter will have a very similar style to blog posts.
  • home - The home layout is meant to act as the homepage of your blog posts - it will display all your blog posts, sorted from newest to oldest. A file using the home layout must be named index.html (not index.md or anything else!).
  • minimal - If you want to create a page with minimal styling (ie. without the bulky navigation bar and footer), assign layout: minimal to the YAML front matter.
  • If you want to completely bypass the template engine and just write your own HTML page, simply omit the YAML front matter. Only do this if you know how to write HTML!

Featured users (success stories!)

Visit the Official website to see sample websites using Beautiful Jekyll.

If you'd like to showcase yourself and join this list, upgrading to the Individual plan will give you that publicity plus some other rewards!

Next steps

Congratulations on making it this far! You now have all the tools to easily build a beautiful website for free.

  • After you get comfortable with the basics of writing in markdown, I suggest taking a look at this sample post and the code that created it to learn some more advanced tips about markdown.

  • I highly recommend going over the Frequently Asked Questions to find out answers to questions you may not even know you have. Every few months I suggest checking the What's New? page to see if there are new features, and learn how to update your site to the newest version when it's time.

  • You can also check out the advanced installation methods that give you a little more control but are harder to use. Keep in mind that Beautiful Jekyll was primarily designed to be used as a GitHub theme, so you will not get any support if you choose one of the Ruby installation methods.

Getting help

Visit the FAQ page for answers to commonly asked questions.

If you choose to become a sponsor, you'll have access to my office hours where you can ask for help. You can also use the Discussions area to try and get help from the community.

Beautiful Jekyll is used by 50,000+ people with wildly varying degrees of web skills, so it's impossible to answer all the questions that may arise. For any question that's not specifically related to Beautiful Jekyll and is more about Jekyll or web development in general, the answer can often be found on Google, in the Jekyll documentation, or on the Jekyll support forum.

Contributions

Thank you to all past contributors. If you find any problems or would like to contribute in any way, feel free to create a pull request/open an issue/send me a message.

You can also contribute by becoming an official sponsor to help keep Beautiful Jekyll well-maintained!

Credits

This template was not made entirely from scratch. I'd like to give special thanks to Jekyll Now and Bootstrap Clean Blog, from whom I've taken several ideas initially.

I'd also like to thank Dr. Jekyll's Themes, Jekyll Themes, and another Jekyll Themes for featuring Beautiful Jekyll in their Jekyll theme directories.

beautiful-jekyll's People

Contributors

abelcheung avatar adrianharabula avatar aisbergde avatar bangjunyoung avatar benattali avatar cketti avatar daattali avatar epwalsh avatar eugenius1 avatar gpotter2 avatar hkhanna avatar hristoyankov avatar jamesonzimmer avatar jennydaman avatar josemyduarte avatar kendaleiv avatar lexicalunit avatar lrdodge avatar mashed-potatoes avatar npes87184 avatar ocram85 avatar orkon avatar pedantic-git avatar sjackman avatar skalee avatar sschwetz avatar supersam654 avatar tony-ho avatar vincenttam avatar xnerv avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

beautiful-jekyll's Issues

How to display the favicon to the page as well as display comment option on blog?

I tried the library and has successfully modified to my need but currently i'm facing little bit of problem in adding the favicon as well as displaying the comments or even a field to type in the comment.
Please let me know if I am doing anything wrong.
Here is the url: http://silverfoxa.github.io/

Moreover when I try to host the same repo in terms of a project it shows error hence says the site does
not exits .i.e i wanted to make the url as http://silverfoxa.github.io/project but the following did not work for me.

favicon.ico setting

A great work for website creating.

I found that there is no "favicon.ico" according to your step-to-step tutorial.

We can set a "favicon.ico" by adding <link rel="icon" href="/img/favicon.ico" /> in the "header.html". Or a yaml parameter "ico" could be offered to control if "favicon.ico" is show to the site.

share buttons not working

I might be missing something, but it seems that none of the demo blog posts shows share buttons, when in the default front matter social-share: true.

[question] nav-short: true

Hi Dean, I would like to know how you made your navbar shorter as your "shiny.html" in your personal website. I tried to figure out myself but couldn't find a way.
If it's simple, I think it would be nice to have the "nav-short: true" option available in this template.
Thanks for the share this project!

[question] specifying a company page on linkedin

The linkedin link at the bottom of the page defaults to www.linkedin.com/in/NAME. If I have a company page I cannot properly link to it (it will paste as 'www.linkedin.com/in/company/NAME' when I use 'company/NAME' in the config file).

I've been looking through all of the files and I cannot find anywhere where you specify how to get from the linkedin name we provide in the config file to the pasted link 'linkedin.com/in/company', as I planned on editing that portion of the code myself.

So, is this in your code somewhere, and if it is, could you point me in the right direction? Else, is this just not an option with the beautiful-jekyll template?

Anchor and footnotes link too far down

Dean - thanks again for the great work. I've added anchors for intra-document references (e.g., "{#header1}") and footnotes (e.g., "[^1]") in my posts, but when you click on the generated link it takes you one row too far down the page -- the top row is cut off by the banner. Is there an easy workaround to resolve this?

Please see the table of contents and/or footnotes in this post for an example. Please see desired footnote functionality here.

Thanks,
Ryan

[question] browser tab image

Sorry to keep bothering you. But I am not seeing where you specified to have the image of yourself be the image that shows up in the browser tab. It isn't the title img or the navigation img. I noticed that it was also your github profile img so I (finally) added an image to my github profile, but that doesn't seem to be it either.

I'm sorry if it's directly in front of me and I'm just missing it. Though looking through a couple of other websites that have used beautiful-jekyll, they do not have a browser tab img set either, so I may not be going crazy.

-Andrew

navbar-links: width

The drop-down menu associated with nvabar-links takes approximately the width of the title of the drop-down. If a subsequent sub-title word is longer than this width, the word stretches across two lines.

Blog post not generated with Next Page/ Previous Page widget

Hi daattali,

Thanks for the beautiful-jekyll and making it easy for newcomers like me. I am trying to build a simple site for my project with your theme. My intension is to create few static pages and a blog page for release announcement. I have hosted it in this link https://github.com/mbusb/mbusb.github.io.

If you build and browse a site, all seems to be ok. But I am finding it difficult to generate a 'News' (blog) page with the "Read More", "Next Page" and "Previous Page" widgets which you normally see in your demo site. Right now my page_news.md content looks like this which generates a posts with long list (without above widgets). If I copy your "index.html" code to my "page_news.md" does not generate any post at all.

I have looked at codes of various "Success Stories" sites from your repo but I could not get what I wanted. Is there anything which I am missing in my project files?

Any help is appreciated.

HTML widgett on Jekyll

Hi Dean,

Not able to render HTML widget (ex. DT, Leaflet) on beautiful-jekyll. Here is the YAML

layout: post
title: "HtmlWidge"
author: "Abiyu Giday"
date: "January 21, 2016"

output: html_document

Can you take a look?

Upgrade to font-awesome 4.4 for wikipedia-w glyph

It would be nice to have soundcloud and wikipedia in the footer. I'm using Hugo static site generator but added this myself and upgraded font awesome.

Thanks for your work!

For hugo I have added this to the footer.html (should be migrated to jekyll):

                  {{ if .Site.Author.soundcloud }}
          <li>
            <a href="https://soundcloud.com/{{ .Site.Author.soundcloud }}" title="SoundCloud">
              <span class="fa-stack fa-lg">
                <i class="fa fa-circle fa-stack-2x"></i>
                <i class="fa fa-soundcloud fa-stack-1x fa-inverse"></i>
              </span>
            </a>
          </li>
          {{ end }}
                  {{ if .Site.Author.wikipedia_en }}
          <li>
            <a href="https://en.wikipedia.org/wiki/User:{{ .Site.Author.wikipedia_en }}" title="Wikipedia">
              <span class="fa-stack fa-lg">
                <i class="fa fa-circle fa-stack-2x"></i>
                <i class="fa fa-wikipedia-w fa-stack-1x fa-inverse"></i>
              </span>
            </a>
          </li>
          {{ end }}

Stackoverflow icons not working as expected

Adding stackoverflow: my-SO-name and stackoverflow: true to footer-links-active inside _config.yml does not work as expected because the baseURL for network profiles looks like www.stackoverflow.com/users/#######/my-SO-name (rather than www.stackoverflow.com/my-SO-name).

As a temporary solution, I set stackoverflow to #######/my-SO-name and edited <a href="https://stackoverflow.com/{{ site.author.stackoverflow }}" to include /users/ inside _includes/footer.html

Syntax highlighting problem

Thanks for repostitory.

I've been working for a long time - trying to get syntax highlighting
on GitHub pages working. It never seems to work.

Any help would be appreciated.

I forked your beautiful-jekyll
http://mrmccormack.me/aboutme/

It works when previewing the .md file in repository... but not on compiled GitHub pages.

Here's what I added:

Here is some sample colored code

<strong>hello world</strong>

Test

{% highlight html%}
hello world
{% endhighlight %}

Another test

def test(i: Int): Unit = {
   println(i)
 }

Help with Navigation

I'm new to this, so please bear with me. I'm having trouble with my navigation menu. I can't figure out how to have my avatar and site name direct to /home. They are both leading to "rfitz9.github.io/rfitz9.github.io"

A few issues reported by a reddit user

There are some issues though:

  • It looks like site.baseurl support is somewhat lacking. I've seen several places where it's not used. Check the output of grep 'site\.url[^-]' -rn . | grep -v baseurl. All of the lines it finds are broken when you have a baseurl.
  • On hosts that don't auto-redirect "foo" to "foo/" (they exist), removing "/index.html" is a bit too aggressive, remove "index.html" instead. (in head.html)
    • For the same reason, be sure to link to {{site.url}}{{base.url}}/ (including the slash) when linking to the base URL itself.
  • For some reason, some of the footer icons don't show up properly here. RSS and LinkedIn are the ones I've noticed, but there might be others. I'm not sure why, so I've just disabled those on my site.

I fixed some of those issues on my site, but because there are too many unrelated changes mixed in I don't feel like cleaning it up and submitting a pull request, sorry.

Markdown code blocks wrapping

Thanks for all your work on this great theme.

Is there anyway to change the default behavior of markdown code blocks. I really don't want them to wrap.

echo "Please tell me a way to stop this from wrapping across multiple lines!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"

HTML file uploaded as a blog post gets incorrect title

I've written a blog post that uses two htmlwidget packages, DT and visNetwork. Therefore, a md file would not be a good option for me.

However, I can't get the blog to fix the title. I generated the file using knitr and Rstudio and changed the YAML parameters as follows:


title: "Meta-análise R (2): Analisando Pacotes R como indivíduos em uma rede social"
author: "Sillas Teixeira Gonzaga"
date: "May 30, 2016"
layout: post
comments: true

output: html_document

However, the string title is now what appears what the home page of the blog, but the string after the date in the file name. So if I name the html file as 2016-05-30-post3.html, then post3 will be the header of that post on the blog homepage.

When I noted this, I copied the title from the YAML header to the file name, but it didn't work properly as it lowercased it.

Link to the blog page
Link to the file in the repo

So, how do I fix the title of a blog entry created by an html file?

main.css is not up-to-date?

I'm trying to create Wordpress theme based on your beautiful-jekyll. All looks fine, but there are differences between your blog and github version. For example github version of main.css doesn't contain .paper definitions. Are you going to update github version? Or can I use your blog version of css?

Thanks for your time and good theme!

bigimg incorporation

Can you incorporate the bigimg headers you have on your personal website into the general distribution?

resizing html file and rendering ipynb in _posts

Hi Dean,

I used your Jekyll template and it's awesome. I am completely new to this so I'm sorry for asking very basic question. I wanted to upload .ipynb file into into the _posts folder but it does not render properly. So I opted to upload an .html file instead. However, the page size is off as you can see here:
https://jpdeleon.github.io/2016-12-07-Tutorial_01_Exoplanet_Plots/

I would like it to render like this: http://nbviewer.jupyter.org/github/jpdeleon/jpdeleon.github.io/blob/master/_posts/2016-12-07-Tutorial_01_Exoplanet_Plots.html

I am always working with Jupyter .ipynb and my wish is to render the file readily in Jekyll by just uploading the .ipynb to _posts. Is this possible? Note that .md file will work but I'm just wondering how it'll be done for ipynb. Thank you!

Few issues with code blocks, and some questions.

After testing out a this theme, I have noticed a few issues with code blocks. (not that I am using ' rather than ` for this issue, because I couldn't work out how to escape it lol) I get the feeling that these issues are more so limitations of the tools used rather than this project, so at the very least this will help others who are having these issues.

The first issue is related to syntax highlighting. I believe there may be some case sensitivity with it. If you were to use '''Java it will not work. But if you use '''java it will.

The second issue is with new lines. If you start a code block directly after text, it will break the formatting. To prevent this, a new line must be between them.

As for my questions, I am wondering if line wrapping on code blocks has been worked out. I am currently writing tutorials about Java programming, and the line wrapping on code blocks can be quite the eye sore. You can see an example page here. I had tried fixing it myself, however the best I could do is disable all line wrapping, which turned all code blocks into one line. I am not very familiar with css though lol.

I have also noticed that the url in the top left links to the github site rather than my domain, which throws a 404. Would you happen to know what I did wrong? The repo for the site can be found here

Thanks for your time, and this awesome theme :)

Issue in integrating Public Custom LinkedIn URL

Expected Behavior

Workaround for someone to be able use their Custom LinkedIn Url, instead of the obsolete pub/username/../../... Url.

Current Behavior

In _config.yml, you have mentioned to use a format similar to - pub/dean-attali/8/946/143 , to link to LinkedIn, however for a long time now I have been using a Custom Public URL - https://www.linkedin.com/in/rishabhbanga , which is not being properly linked using the current code.

Solution

Created Pull Request for the same.

[question] image as 'title'?

Currently beautiful-jekyll takes the website 'title' and makes it a link in the top left corner than links back to index.html.

I would like to put my company's logo at the top left instead, and still have it be linked back to index.html.

Would this feature be feasible within the current scope of beautiful jekyll?

"forking" updates (?)

Hello there,
1st of all, sorry if this question ends up being stupid.

I'm using this theme at my github.io page but I was wondering what should I do (if anything at all) to take advantage of updates made in this original repo?

Clearly I don't fully understand how forking etc works but I also coudn't find any answer.
Thank you and best regards!

<div class=container> content extends outside of <div class="container" role="main"> in pages

Containers within pages extend outside of their row in the

Example page:

layout: page
title: Meet The Team
---

We are a group of researchers based at the University of Oxford who are passionate about research reproducibility and open research. The project aims to bring together expertise in these areas from across the University, and our members work in a diverse range of disciplines in the natural, medical, and social sciences, and in the humanities.

<div class="container">
<div class="row justify-content-center">

<div class="col-sm-4" style="text-align:center">

<a href="../laura-fortunato"><img src="../img/profile-pic_laura-fortunato.jpg" style="border-radius: 50%;
    width: 150px;
    height: 150px;"/></a>

</div>

<div class="col-sm-4" style="text-align:center">

<a href="../philip-fowler"><img src="../img/profile-pic_phillip-fowler.jpg" style="border-radius: 50%;
    width: 150px;
    height: 150px;"/></a>

</div>

<div class="col-sm-4" style="text-align:center">

<a href="../martin-john-hadley"><img src="../img/profile-pic_martin-john-hadley.jpg" style="border-radius: 50%;
    width: 150px;
    height: 150px;"/></a>

</div>

</div>
</div>

image

Rows can be added without containers, but I believe it's best practice to always wrap containers around rows?

I had a quick look into how to fix this myself, but couldn't figure it out.

Support multi-level navbar

See if there's an elegant simple way to support dropdown menus in the navbar links. Only if it's easy to use from the user's perspective and involves minimal code change, and make sure it looks good on both mobile and big screen.

Code wrapping

Hi @daattali, code automatically wraps which makes it hard to read, particularly from mobile devices. I propose adding something like this to main.css:

.highlighter-rouge  code * {
    white-space: nowrap;
}

.highlighter-rouge pre {
    overflow-x: auto;
}

.highlighter-rouge pre code {
    white-space: pre;
}

This would disable wrapping and allow for horizontal scrolling.

EDIT: This solution actually had some unexpected behavior from a mobile browser, so maybe not the best way to go.

About page not rendering

I am facing following error with about me page. I have updated markdown and it renders fine in hintikkakimmo.github.io, but not when developing locally?

If I run Jekyll server command and click the link I get 404 error page, if I do the same on the github page it works fine.

Just in case I did run bundle install, updated bundler, Jekyll build and Jekyll build --watch with no error but serving page locally just does not seem to work. Similar happen with post time to time as well.

If I look at _site folder I can find properly generated HTML files for both post and aboutme.

Bundler 1.1.2, Ruby 2.2.1 and Jekyll 2.4.0

[Not a issue] Post image in navbar avatar

If I set a picture in a post (image: in the front matter) it's displayed instead of the default avatar in the navbar.
It's possible to display it below the title of the post and leave the default avatar?

Sorry for my poor english

quick question about /img/start.jpg and /img/path.jpg

Hi.

I get what the 404-southpark.jpg is (though I don't get why it's not simply called 404.jpg), I get what the avatar-icon.png is. But what are the other two images, path and start? They're not used in the sample posts, they're not used in the readme, and I haven't seen them in the layouts or includes... what are they?

Moving Blog to another Page

Taking the blog-emitting src from index.html (this stuff), and moving it to a new page, say blog.html, results in no post-html to be emitted:

<div class="container" role="main">
  <div class="row">
    <div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
      <div class="posts-list">

</div>



    </div>
  </div>
</div>

Moving it back to the root index.html, and running jekyll serve then properly emits all blog-related HTML.

What is intrinsic to the root index.html that allows blog-html to be emitted? How can I transfer this logic to another page, blog.html?

Thank you so much!

James

bigimg on an old version

Hello There

I am using a fork since Feb 2016, and I don't think bigimg is supported at that time, as I made some changes to the theme myself, I am wondering what are the changes I need to bring to my fork so that I can add support to bigimg

any idea ?

Last commit I have from yours is abc9e978bf81cc746eb3de55be5896768b9369b0 which is a year ago

Add permalink to 404.html

the page 404.html with the current header will not display if the website is hosted on github

I fixed this by adding a

permalink: /404.html

I don't think this needs a PR since I added other things but I though you might want to fix that

Cheers

Rad

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.