{"id":13511751,"url":"https://github.com/rohanchandra/type-theme","last_synced_at":"2025-05-15T04:05:49.122Z","repository":{"id":25464259,"uuid":"28894617","full_name":"rohanchandra/type-theme","owner":"rohanchandra","description":"A free and open-source Jekyll theme with responsive design. Great for blogs and easy to customize.","archived":false,"fork":false,"pushed_at":"2023-01-15T11:09:22.000Z","size":342,"stargazers_count":712,"open_issues_count":4,"forks_count":567,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-14T05:55:26.594Z","etag":null,"topics":["github-pages","jekyll","jekyll-theme","jekyll-themes"],"latest_commit_sha":null,"homepage":"https://rohanchandra.github.io/type-theme/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rohanchandra.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-07T02:37:24.000Z","updated_at":"2025-04-09T01:37:07.000Z","dependencies_parsed_at":"2023-01-16T22:15:29.520Z","dependency_job_id":null,"html_url":"https://github.com/rohanchandra/type-theme","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohanchandra%2Ftype-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohanchandra%2Ftype-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohanchandra%2Ftype-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rohanchandra%2Ftype-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rohanchandra","download_url":"https://codeload.github.com/rohanchandra/type-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254270646,"owners_count":22042859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-pages","jekyll","jekyll-theme","jekyll-themes"],"created_at":"2024-08-01T03:01:09.373Z","updated_at":"2025-05-15T04:05:44.098Z","avatar_url":"https://github.com/rohanchandra.png","language":"HTML","readme":"# Type Theme\n\n![Default Type Theme blog](https://user-images.githubusercontent.com/816965/30518919-d5978024-9bcd-11e7-81b3-3dd07e99a1f9.png)\n\nA free and open-source [Jekyll](https://jekyllrb.com) theme. Great for blogs and easy to customize.\n\n[Demo](https://rohanchandra.github.io/type-theme/)\n\n## Usage\n\n1. Fork and clone the [Type Theme repo](https://github.com/rohanchandra/type-theme): `git clone https://github.com/rohanchandra/type-theme`\n2. [Install Jekyll](https://jekyllrb.com/docs/installation/): `gem install jekyll`\n3. Install the theme's dependencies: `bundle install`\n4. Customize the theme (see below)\n5. Run the Jekyll server: `jekyll serve`\n\n## Customizing Type Theme\n\nOpen `_config.yml` in a text editor to change most of the blog's settings.\n\nIf a variable in this document is marked as \"optional\", disable the feature by removing all text from the variable. For example, to prevent the avatar from rendering in the header, the avatar line should read:\n\n```yml\ntheme:\n  title: Type Theme\n  avatar:\n  gravatar:\n```\n\nNotice the avatar variable is left intentionally blank.\n\nBelow is a summary of the configuration options in Type Theme.\n\n### Site configuration\nThe most common configurations, included here for guidance, are:\n\nJekyll website *without* a subpath (such as a GitHub Pages website for a given username):\n\n```yml\n# SITE CONFIGURATION\nbaseurl: \"\"\nurl: \"https://username.github.io\"\n```\n\nJekyll website *with* subpath (like the Type Theme demo page):\n\n```yml\n# SITE CONFIGURATION\nbaseurl: \"/sub-directory\"\nurl: \"https://username.github.io/\"\n```\n\nPlease configure this in `_config.yml` before using the theme.\n\n### Meta\n\nMeta variables hold basic information about your Jekyll site which will be used throughout the site and as meta properties for search engines, browsers, and the site's RSS feed.\n\nChange these variables in `_config.yml`:\n\n| Variable    | Example                          | Description                                                                                                                    | Optional |\n| ----------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------- |\n| title       | My Jekyll Blog                   | Name of website                                                                                                                | Yes      |\n| avatar      | assets/img/avatar.png            | Path of avatar image, to be displayed in the theme's header                                                                    | Yes      |\n| gravatar    | f9879d71855b5ff21e4963273a886bfc | [MD5 hash of your email address](https://secure.gravatar.com/site/implement/hash/) to load your Gravatar in the theme's header | Yes      |\n| description | My blog posts                    | Short description, primarily used by search engines                                                                            | Yes      |\n\n### Header and footer text\n\nChange these variables in `_config.yml`:\n\n\n| Variable                  | Example                             | Description                                                             | Optional |\n| ------------------------- | ----------------------------------- | ----------------------------------------------------------------------- | -------- |\n| header_text               | Welcome to my Jekyll blog           | HTML (shown below the navigation) with a background colour for emphasis | Yes      |\n| header_text_feature_image | assets/img/sample_feature_img_3.png | Background image for the header text                                    | Yes      |\n| footer_text               | Copyright 2014                      | HTML (shown at end of the site) with lighter text                       | Yes      |\n\n### Icons\n\nAdd your username on selected websites in the icon section of the `_config.yml` file to display the site's icon from [Font Awesome](https://fortawesome.github.io/Font-Awesome/) in the header navigation. All icon variables should be your username enclosed in quotes (e.g. \"username\"), except for the following variables:\n\n\n| Variable       | Example                                         | Description                                            | Optional |\n| -------------- | ----------------------------------------------- | ------------------------------------------------------ | -------- |\n| rss            | true                                            | Takes boolean value (true/false) to show RSS feed icon | Yes      |\n| email_address  | type@example.com                                | Email address                                          | Yes      |\n| linkedin       | https://www.linkedin.com/in/FirstLast           | Full URL to profile on LinkedIn                        | Yes      |\n| stack_exchange | https://stackoverflow.com/users/0000/first-last | Full URL to profile on Stack Exchange                  | Yes      |\n\n### Scripts\n\nChange these variables in `_config.yml`:\n\n\n| Variable         | Example      | Description                                                                                                                         | Optional |\n| ---------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| google_analytics | UA-123456-01 | Google Analytics [tracking ID](https://support.google.com/analytics/answer/1032385?hl=en)                                           | Yes      |\n| disqus_shortname | shortname    | Disqus [shortname](https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-)                                     | Yes      |\n| katex            | true         | Takes boolean value (true/false) to conditionally load [KaTeX](https://khan.github.io/KaTeX/) scripts required for math typesetting | Yes      |\n\nScripts listed here are only loaded if you provide a value in the `_config.yml` file.\n\n### Localization strings\n\nChange localization string variables in `_config.yml`.\n\nEnglish text used in the theme (such as the \"continue reading\" label) has been grouped  so you can quickly translate the theme or change labels to suit your needs.\n\n### Colours, typography, padding\n\n![A selection of colours set in Type Theme by modifying the CSS](https://cloud.githubusercontent.com/assets/816965/5142488/130869a6-71d7-11e4-8a38-a69ec1673436.png)\n\n\n| Variable     | Example                    | Description                          | Optional                                                     |\n| ------------ | -------------------------- | ------------------------------------ | ------------------------------------------------------------ |\n| google_fonts | \"Playfair+Display:400,700\\ | PT+Sans:400,700,700italic,400italic\" | [Google Fonts](https://www.google.com/fonts) to load for use |\n\nNavigate to the `_sass \u003e base` directory and open `_variables.scss` to change colours, typography and padding used in the theme with CSS.\n\nOnce you have loaded a Google Font in `config.yml`, you can integrate the fonts into your CSS by changing the font-family in `_variables.scss`. For example, after loading the Playfair Display and PT Sans fonts from Google:\n\n```css\n// Typography\n$font-family-main: 'PT Sans', Helvetica, Arial, sans-serif;\n$font-family-headings: 'Playfair Display', Helvetica, Arial, sans-serif;\n```\n\nMozilla's [ColorPicker](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Colors/Color_picker_tool) is a helpful tool to get your preferred colours in hexadecimal or RGBA form for use in `_variables.scss`.\n\n### Customize style when using the remote_theme\n\nIf you're using Type Theme as a `remote_theme`, you can override variables and styles.\nTo do so, simply create a `assets/css/main.scss` file on your website with the following content:\n\n```scss\n// assets/css/main.scss\n---\n---\n\n@import \"type-theme\";\n```\n\n`@import \"type-theme\";` includes the theme styles, so you can add custom imports before and after it, depending on your needs.\nBest practice is to put your custom files in the `_sass` folder of your project. Jekyll will automatically look for them there.\nFor example, say you wanted to override some theme variables and add some custom styles, you can create the following files:\n\n```scss\n// _sass/_variables.scss\n$background-color: black;\n```\n\n```sass\n// _sass/_custom.sass\n\n// SASS is supported as well, just note the file extension is .sass\n.feature-image header\n  height: 300px\n```\n\nThen import them both into `main.scss`:\n\n```scss\n// assets/css/main.scss\n---\n---\n\n@import \"variables\";\n@import \"type-theme\";\n@import \"custom\";\n```\n\n## Posts and pages in Type Theme\nPlease refer to the [Jekyll docs for writing posts](https://jekyllrb.com/docs/posts/). Non-standard features are documented below.\n\n### Math typesetting\nWrap math expressions with `$$` signs in your posts and make sure you have set the `katex` variable in `_config.yml` to `true` for math typesetting.\n\nFor inline math typesetting, type your math expression on the *same line* as your content. For example:\n\n```latex\nType math within a sentence $$2x^2 + x + c$$ to display inline\n```\n\nFor display math typesetting, type your math expression on a *new line*. For example:\n\n```latex\n$$\n  \\bar{y} = {1 \\over n} \\sum_{i = 1}^{n}y_i\n$$\n```\n\nType Theme makes use for [KaTeX](https://khan.github.io/KaTeX/) for typesetting.\n\n### Feature images\n\n![Posts with geometric feature images](https://cloud.githubusercontent.com/assets/816965/5142406/19726478-71d6-11e4-8111-94f788b0e44d.png)\n\nAdd a feature image by specifying a path to an image in the [front matter](http://jekyllrb.com/docs/frontmatter/) in the form of `feature-img: \"img/PATH_TO_IMAGE.png\"`.\n\nFor example:\n\n```yml\n---\nlayout: post\ntitle: Hello World\nfeature-img: \"assets/img/sample_feature_img.png\"\n---\n```\n\nBy default, the page title is displayed on top of the feature image, as well as on the browser's tab. You can change the feature image's displayed title by specifying a `feature-title` in the front matter:\n\n```yml\n---\nlayout: post\ntitle: Short title\nfeature-title: A much longer title\nfeature-img: \"assets/img/sample_feature_img.png\"\n---\n```\n\n### Hiding pages from navigation\n\nIn the front matter of a page, add `hide: true` to prevent the page from showing up in the header's navigation bar (visitors can still visit the URL through other means).\n\nFor example:\n\n```yml\n---\nlayout: page\ntitle: \"Error 404: Page not found\"\npermalink: /404.html\nhide: true\n---\n```\n\n### Sorting pages in navigation\n\nYou can configure this theme to **sort your pages** in the header's navigation bar.\n\n- Set `site_navigation_sort` in theme settings to a property name e.g. `'order'`\n- In the front matter of a non-hidden page, add `order: n`\n\nFor example:\n\n```yml\n---\nlayout: page\ntitle: Team\npermalink: /team/\norder: 4\n---\n```\n\n### Tags\n\nPost tags should be placed between `[]` in your post metadata. Separate each tag with a comma.\n\nFor example:\n\n```yml\n---\nlayout: post\ntitle: Markdown and HTML\ntags: [sample, markdown, html]\n---\n```\n\nA tags listing will be automatically generated using the `tags.html` file provided in Type Theme. If you're not using the tags feature it is safe to delete `tags.html`.\n\n### Search\n\nThe search feature can be activated in the `_config.yml` file by changing its value from `false` to `true`.\n\n```yml\n  #Scripts\n  search: true\n```\n\nOnce activated, the search bar will appear in the header. This feature uses [Lunr](https://lunrjs.com/) and searches through the title, tags and content of your posts.\n\n### Subtitles\nA subtitle can be displayed below your title on permalink post pages.\n\nTo enable this feature, add `subtitle` to your post metadata.\n\nFor example:\n\n```yml\n---\nlayout: post\ntitle: \"This is a title\"\nsubtitle: \"This is a subtitle\"\n---\n```\n\n## License\n[The MIT License (MIT)](https://github.com/rohanchandra/type-theme/blob/master/LICENSE)\n","funding_links":[],"categories":["HTML","Jekyll","jekyll-theme"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohanchandra%2Ftype-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frohanchandra%2Ftype-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohanchandra%2Ftype-theme/lists"}