Code Monkey home page Code Monkey logo

minimal's Introduction

The Minimal theme

.github/workflows/ci.yaml Gem Version

Minimal is a Jekyll theme for GitHub Pages. You can preview the theme to see what it looks like, or even use it today.

Thumbnail of Minimal

Usage

To use the Minimal theme:

  1. Add the following to your site's _config.yml:

    remote_theme: pages-themes/[email protected]
    plugins:
    - jekyll-remote-theme # add this line to the plugins list if you already have one
  2. Optionally, if you'd like to preview your site on your computer, add the following to your site's Gemfile:

    gem "github-pages", group: :jekyll_plugins

Customizing

Configuration variables

Minimal will respect the following variables, if set in your site's _config.yml:

title: [The title of your site]
description: [A short description of your site's purpose]

Additionally, you may choose to set the following optional variables:

show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]

Stylesheet

If you'd like to add your own custom styles:

  1. Create a file called /assets/css/style.scss in your site
  2. Add the following content to the top of the file, exactly as shown:
    ---
    ---
    
    @import "{{ site.theme }}";
  3. Add any custom CSS (or Sass, including imports) you'd like immediately after the @import line

Note: If you'd like to change the theme's Sass variables, you must set new values before the @import line in your stylesheet.

Layouts

If you'd like to change the theme's HTML layout:

  1. For some changes such as a custom favicon, you can add custom files in your local _includes folder. The files provided with the theme provide a starting point and are included by the original layout template.
  2. For more extensive changes, copy the original template from the theme's repository
    (Pro-tip: click "raw" to make copying easier)
  3. Create a file called /_layouts/default.html in your site
  4. Paste the default layout content copied in the first step
  5. Customize the layout as you'd like

Customizing Google Analytics code

Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into _includes/head-custom-google-analytics.html in your Jekyll site.

Overriding GitHub-generated URLs

Templates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs:

  1. Look at the template source to determine the name of the variable. It will be in the form of {{ site.github.zip_url }}.
  2. Specify the URL that you'd like the template to use in your site's _config.yml. For example, if the variable was site.github.url, you'd add the following:
    github:
      zip_url: http://example.com/download.zip
      another_url: another value
  3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub.

Note: You must remove the site. prefix, and each variable name (after the github.) should be indent with two space below github:.

For more information, see the Jekyll variables documentation.

Roadmap

See the open issues for a list of proposed features (and known issues).

Project philosophy

The Minimal theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.

Contributing

Interested in contributing to Minimal? We'd love your help. Minimal is an open source project, built one contribution at a time by users like you. See the CONTRIBUTING file for instructions on how to contribute.

Previewing the theme locally

If you'd like to preview the theme locally (for example, in the process of proposing a change):

  1. Clone down the theme's repository (git clone https://github.com/pages-themes/minimal)
  2. cd into the theme's directory
  3. Run script/bootstrap to install the necessary dependencies
  4. Run bundle exec jekyll serve to start the preview server
  5. Visit localhost:4000 in your browser to preview the theme

Running tests

The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run script/cibuild. You'll need to run script/bootstrap once before the test script will work.

minimal's People

Contributors

benbalter avatar beol avatar coliff avatar ericfromcanada avatar gebeto avatar jmuccigr avatar kmyk avatar mgifford avatar ousia avatar parkr avatar quytelda avatar sjsakib avatar tsusdere avatar vitalyzhakov avatar znegva 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

minimal's Issues

Check to see whether page is an organization page

In

{% if site.github.is_project_page %}
<p class="view"><a href="{{ site.github.repository_url }}">View the Project on GitHub <small>{{ github_name }}</small></a></p>
{% endif %}
{% if site.github.is_user_page %}
<p class="view"><a href="{{ site.github.owner_url }}">View My GitHub Profile</a></p>
{% endif %}
, the code checks to see whether the page is a user page or project page. However, organization pages should also be checked (and should minimally be treated like project pages).

<ul>s in the header shouldn't all be styled like download lists.

This issue has been brought up before: See Issue #19.

If a theme user tries to customize the theme by adding a new <ul> to the sidebar (the <header> section of _layouts/default.html), the theme will try to style the list like the three element downloads list.

The expected behavior would be for the <ul> to inherit the default body style (or some sane default), allowing the user to more easily write custom styles in assets/css/styles.scss.

I think this can be fixed easily by rewriting the downloads list to be a special class of ul (which I will do), but I opened this issue in case there are other considerations here that I'm unfamiliar with, seeing as the issue has been closed previously without a fix.

Fenced code blocks not working

I am using this theme but I would like to use fenced code blocks for code snippets in my page and it is not working. Nevertheless the {% highlight python %} ... {% endhighlight %} is working.

How to fix it?

Best,

Luis Santos

Add ability for links in the side panel

I really like the minimal feel this theme gives, but I've come across the need to create more another-page.md like pages to make the front page less cluttered. While the example another-page.html has a back link to get to the front page again, when there are multiple "pages" it would be nice to have them all in the side bar so the user does not need to constantly click back to go through all the pages.

An example of where I think this feature would be helpful is here: https://chendaniely.github.io/2018-10-python1/

How I think this can be easily implemented is in the _layouts/default.html file where we can put a section for sidebar pages in the _config.yaml and it lists those pages in an un-ordered list of sorts.
Would be happy to send the PR if you think this fits with the scope and goals of the project.

post layout?

Any reason for the lack of post layout?

I've just started to use the theme (thanks!) and for posts have removed the title above the content, and put the page title in the header (which I've added to the _config.yml).

.github/workflows/ci.yaml

Hi,

I found an issue from ci.yaml as below:

Run script/bootstrap
/home/runner/work/_temp/63854597-b0cf-41b3-a7a5-dc2b0c4df45f.sh: line 1: script/bootstrap: Permission denied
Error: Process completed with exit code 126.

Any advice on how I can eliminate this error?

Thank you

Accessibility errors found in your template

The user @carlsonsantana validate your site template "https://pages-themes.github.io/minimal/" and found these accessibility errors:

  • Page https://pages-themes.github.io/minimal/:
    • Issue 7c9716ac-0cf1-4fbd-8e13-871ae1cfe88a:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
      • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 4.49:1. Recommendation: change background to #f9f9f9.
      • Selector: html > body > div > section > div:nth-child(11) > div > pre > code > span:nth-child(4)
      • Context: <span class="no">Dependencies</span>
    • Issue 9fbcf03e-5945-4d98-b526-d990e07ac2da:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
      • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 4.49:1. Recommendation: change background to #f9f9f9.
      • Selector: html > body > div > section > div:nth-child(11) > div > pre > code > span:nth-child(2)
      • Context: <span class="no">GitHubPages</span>
    • Issue 887f35e1-56b9-4be8-92b8-831dac729f70:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
      • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.72:1. Recommendation: change text colour to #737362.
      • Selector: html > body > div > section > div:nth-child(11) > div > pre > code > span:nth-child(1)
      • Context: <span class="c1"># Ruby code with syntax highlig...</span>
    • Issue bd91bd1f-5ead-4f55-96f4-cf663de1b80c:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
      • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 2.72:1. Recommendation: change text colour to #737362.
      • Selector: html > body > div > section > div:nth-child(10) > div > pre > code > span:nth-child(1)
      • Context: <span class="c1">// Javascript code with syntax ...</span>
    • Issue 22afde61-cd46-4cbb-be9d-f65147e6a502:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Fail
      • Message: This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of 4.48:1. Recommendation: change text colour to #767676.
      • Selector: html > body > div > header > p:nth-child(4) > a > small
      • Context: <small>pages-themes/minimal</small>

You can check these accessibility errors using pa11y.
You can view the full validation results in our website.

Floating Footer covers content

I am using the theme via GitHub pages and notice that the page footer is effectively floating on top of my page content - meaning that the text of my content and the footer are illegible.

The footer is this:
"This page was generated by GitHub Pages. "

Is this the intended design?

Configuring package download options

Hi! At the present the three options for package downloading are directly hardcoded into the HTML layout and the third one of them is repetitive with "View on Github". Do you think it could be easily extendable to any three options (button texts and links) we would like to add? They can still be three in order to obey the overall layout so there is no need to make anything other than the texts and links configurable. For instance, I would like my three options to be PIP/RPM/DEB. Any help is appreciated!

Header and footer overlap with short and wide browser window

Hi,

Just wanted to share that sometimes the header and footer can display on top of each other in a desktop browser. When the window becomes narrow enough, it switches to single column display. However, if you just make the window shorter, it keeps the 2 column format and the header and footer can overlap.

Best,
Vincent

width of right frame

Is there a way to decrease the size of the left frame (containing the logo) and increase that of the right frame?

I played around in "jekyll-theme-minimal.scss" with the following width values:

header {
width:270px;
float:left;
position:fixed;
-webkit-font-smoothing:subpixel-antialiased;
}


header {
padding-right:320px;
}


section {
width:500px;
float:right;
padding-bottom:50px;
}


The result looked fine on the PC but didn't work on my mobile phone. I also checked the internet for information but couldn't find any help. Does anyone know?

Icon adding guide needed

I wanna add an icon to my site, but it doesn't accept it. I got a 32x32 image on Github, and theme is minimal. But, my site is in Cayman right now and the icon is making it crash. Can you tell how to solve this error? Must I use an ico file?

Maybe a little bug occured(?

Dear developers, I found that when the image we choose in _config.yml(logo: /assets/img/xxxxx.jpg) is too long, the 'View My GitHub Profile' botton and 'orderedlist' button will overlap and the 'View My GitHub Profile' botton cannot be clicked. Maybe this is a bug? Or just I made the settings wrong?

Tables Not Working

I tried to install this theme and the installation worked. However, my table that showed up on another theme just fine.

Unable settin up theme

Hello,

I'm trying to preview my site locally and eventually publish it on my github page.

I'm following documentation: I have added theme: jekyll-theme-minimal to my _config.yml file, and I have added gem "github-pages", group: :jekyll_plugins to my Gemfile.

I am now able to run locally with bundle exec jekyll serve but the website still has the base Jekyll theme. Also I have merged on github and githubpage still shows the base Jekyll as well.

Not sure why, sorry for the simple question, I'm new to Ruby and Jekyll.

bundle exec jekyll serve outputs error

I followed the theme usage instructions and the site does not build after configuring the theme. There is a theme could not be found error. Did I miss something? How do I get the site to build with the theme configured?

/tmp $ jekyll -v
jekyll 3.8.3
/tmp $ ruby -v
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin15]
/tmp $ jekyll new minimal-test-site
Running bundle install in /private/tmp/minimal-test-site...
  Bundler: The dependency tzinfo-data (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for x86-mingw32, x86-mswin32, x64-mingw32, java. To add those platforms to the bundle, run `bundle lock --add-platform x86-mingw32 x86-mswin32 x64-mingw32 java`.
  Bundler: Fetching gem metadata from https://rubygems.org/...........
  Bundler: Fetching gem metadata from https://rubygems.org/.
  Bundler: Resolving dependencies...
  Bundler: Using public_suffix 3.0.2
  Bundler: Using addressable 2.5.2
  Bundler: Using bundler 1.16.2
  Bundler: Using colorator 1.1.0
  Bundler: Using concurrent-ruby 1.0.5
  Bundler: Using eventmachine 1.2.7
  Bundler: Using http_parser.rb 0.6.0
  Bundler: Using em-websocket 0.5.1
  Bundler: Using ffi 1.9.25
  Bundler: Using forwardable-extended 2.6.0
  Bundler: Using i18n 0.9.5
  Bundler: Using rb-fsevent 0.10.3
  Bundler: Using rb-inotify 0.9.10
  Bundler: Using sass-listen 4.0.0
  Bundler: Using sass 3.5.6
  Bundler: Using jekyll-sass-converter 1.5.2
  Bundler: Using ruby_dep 1.5.0
  Bundler: Using listen 3.1.5
  Bundler: Using jekyll-watch 2.0.0
  Bundler: Using kramdown 1.17.0
  Bundler: Using liquid 4.0.0
  Bundler: Using mercenary 0.3.6
  Bundler: Using pathutil 0.16.1
  Bundler: Using rouge 3.1.1
  Bundler: Using safe_yaml 1.0.4
  Bundler: Using jekyll 3.8.3
  Bundler: Using jekyll-feed 0.10.0
  Bundler: Using jekyll-seo-tag 2.5.0
  Bundler: Using minima 2.5.0
  Bundler: Bundle complete! 4 Gemfile dependencies, 29 gems now installed.
  Bundler: Use `bundle info [gemname]` to see where a bundled gem is installed.
New jekyll site installed in /private/tmp/minimal-test-site.
/tmp $ cd minimal-test-site
/tmp/minimal-test-site $ cat _config.yml | grep theme
theme: minima
/tmp/minimal-test-site $ sed -i '' "s/minima/jekyll-theme-minimal/g" _config.yml
/tmp/minimal-test-site $ cat _config.yml | grep theme
theme: jekyll-theme-minimal
/tmp/minimal-test-site $ bundle exec jekyll serve
Configuration file: /private/tmp/minimal-test-site/_config.yml
jekyll 3.8.3 | Error:  The jekyll-theme-minimal theme could not be found.

post.html in {{ page.author | default: site.author }}

Q.

by {{ page.author | default: site.author }}

{{ page.author | default: site.author }}
This item comes to import your data from anywhere.
Display is labeled only by.

31 August 2018 - date
metamask Setup.-title
by - only by

Page build failure

Hi
I got this error when setting up github pages with this theme,
the email I got doesn't have any description related with the failure.
I just change the default theme to 'jekyll-theme-minimal', it builds fine when switch back to 'minima' theme.
Thanks.

adding email or twitter link below "View My GitHub Profile"

I'm using this very nice theme but I obtained it via the "change theme" option in the GitHub pages section of settings. This means that I only seem to have access to README.md and _config.yml. Perhaps because of this, or perhaps because I simply have no idea what I'm doing, I'm having some trouble with customising the website.

Is there a way to add more links below "View My GitHub Profile" on the left-hand side? e.g. A link to twitter, or an email link?

Many thanks for making such a great theme!

Setting site.github.is_project_page

Is it possible to modify in the _config.yml or jekyll Front Matter the setting for site.github.is_project_page in order to modify the behaviour of the website-building in _layouts/defaut.html

I tried several combination, but did not get it to work. Thanks in advance!

Strange posts layout on mobile devices when code blocks are present

Here are two examples. Here is a link to one of my posts: post_1.
As you reduce the width of the browser window the contents of the post is correctly pushed into new lines.

Here is another example: post_2.
If we reduce the window width we can see that some contents are not pushed to the next line. Instead part of the content is displayed off of the screen (or browser window).

It seems the problem is caused by the code snippet block: ```C some code ```. By removing those blocks, the layout returns to normal state. (More specifically, if the code in the block exceeds certain length then they will be displayed entirely in one line instead of showing scrolling options.) It seems the display size is set to the max code block width instead of screen width. Mathjax also causes the page width to be set to that of the longest formula in the post. Is there any to fix the issue on mobile devices? Thanks.

There should be a way to add lists in the sidebar

If I want to put a unordered list like this in the sidebar:

screen shot 1

I get something like this:

screen shot 2

I believe this is because of minimal's special treatment of lists in the sidebar for the Download links. However, I am aiming for a list like the first one I showed - one that is the same as a list in the rest of the page.

There should be a rule to only make lists in the sidebar this way with a special class, so that users can have regular unordered lists in the sidebar.

relative urls missing base url on project page

I have a project page (https://user.page/project)

In my index.html if I make a link like so:

<a href="/foo/">/foo</a>

The link builds as https://user.page/foo

rather than https://user.page/project/foo (as expected)

I went so far as to add a base tag to the head.

<base href="{{ site.url }}">


I have other project pages that create the urls just fine, and I have the same settings in config.yml.. so I'm at a loss.

https://infominer.id/bitcoin-history

the very first link on that page is an example ^^^

thank you!

Make the logo a link [feature request]

I'd love for the logo to link to a page, perhaps with a logo_url parameter in the _config.yml. It'd be particularly useful when the logo is a CC-BY image from Wikipedia, so the image could link to the original source. As a workaround, I'm setting the description to the URL of the Wikipedia page.

How can add links to the bar on the side.

I am using the minimal them in a couple simple repos. I want to add links to each page on the side of the page (above the "View the project on GitHub" button but below the logo. How can I do this?

Support for favicons

I've already overridden the default.html to add a <link rel="shortcut icon"..., but it would be nice if the theme came with support for a favicon out of the box. Perhaps a favicon key could be added to the _config.yml to specify a path to the image asset.

A more semantic nav menu

Hi ๐Ÿ˜„

Just a small suggestion. Shouldn't the nav manu on the sidebar be more semantic using unordered lists instead of <p>'s? Should be simple enough to use a class for naviation purposes

Thanks a lot for your work!!

XML code preview breaking

If I'm trying to preview an XML code snippets, The page design is breaking. please following the given instruction

---
layout: default
---
1. _Add the following:_
```xml
<string name="test" translatable="false">TEST</string>
```

The result is like below

screen shot 2018-11-03 at 4 33 52 am

If I add a tab or anything character except space before the opening angle bracket it works like a charm.

screen shot 2018-11-03 at 4 34 07 am

Customisable wording for GitHub link

For a user page, the GitHub link is behind the fixed wording "View My GitHub Profile". In our case, this wording (specifically the word "my") doesn't quite make sense as the profile is for an organisation, rather than a user.

Would it be possible to allow the wording to be customised for such links?

Using Multiple default.html pages?

This is probably a misuse of an issue, but I want to add custom links to the left side of the index Markdown page. I discovered that I can create a _layouts/default.html file, which works well. However, I'd also like to have different pairings of markdown files and default.html files. Is there a way to do this? Can I specify for a particular markdown file which corresponding default.html I want used?

Adding LaTeX support

Dear Minimal theme,

I would love to see LaTeX support for the theme; this would be extremely helpful for writing equations in text. I have attempted to write code in my own branch of minimal to implement MathJax, as per the instructions here: http://sgeos.github.io/github/jekyll/2016/08/21/adding_mathjax_to_a_jekyll_github_pages_blog.html

Unfortunately, my implementation was not successful; I am a GitHub novice, so that might be why it failed. It should only be a few lines of code.

Best wishes,

Jason

dark mode (auto) toggle?

It'd be awesome if minimal would support

@media (prefers-color-scheme: light | dark)

and/or have an explicit toggle for users

and/or have a _config.yaml option

Thanks!

Page title in default layout

The page title seems a bit long with the combination of the site title and its author (which requires github btw). Would it make sense to shorten it by eliminating the author info? This would leave it:

<title>{{ site.title | default: site.github.repository_name }}</title>

In Internet Explorer, font shows as Times Roman?

I love the look of Minima in Google Chrome and Firefox. But in Internet Explorer 11, it appears to be displaying the font as Times new Roman. What's particularly weird is that when I used Internet Explorer's inspector, the font family look like it was showing up properly, and it included several fonts, such as Helvetica and Arial that IE certainly has.

Here's what it looks like with IE 11 on the following page:
https://jekyll.github.io/minima/junk/2016/05/20/this-post-demonstrates-post-content-styles.html
Minima-on-IE

Any idea what's going on?

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.