{"id":13654801,"url":"https://nlp4prog.github.io/2021/","last_synced_at":"2025-04-23T10:31:33.503Z","repository":{"id":217136658,"uuid":"303332154","full_name":"nlp4prog/2021","owner":"nlp4prog","description":"The official website for the Natural Language Processing for Programming workshop 2021. Based on https://github.com/sylhare/Type-on-Strap template.","archived":false,"fork":false,"pushed_at":"2021-08-18T17:50:54.000Z","size":16553,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-10T06:34:10.378Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/nlp4prog.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-12T08:50:05.000Z","updated_at":"2021-08-18T17:50:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"336226f8-f335-40f1-be30-675f2f393227","html_url":"https://github.com/nlp4prog/2021","commit_stats":null,"previous_names":["nlp4prog/2021"],"tags_count":0,"template":false,"template_full_name":"sylhare/Type-on-Strap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlp4prog%2F2021","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlp4prog%2F2021/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlp4prog%2F2021/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlp4prog%2F2021/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nlp4prog","download_url":"https://codeload.github.com/nlp4prog/2021/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250416379,"owners_count":21426981,"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":[],"created_at":"2024-08-02T03:00:47.440Z","updated_at":"2025-04-23T10:31:33.447Z","avatar_url":"https://github.com/nlp4prog.png","language":"HTML","funding_links":[],"categories":["Talks and Tutorials"],"sub_categories":["Papers (This list is a bit outdated, need to update)"],"readme":"# Type on Strap 🎨\n\n[![Build Status](https://travis-ci.org/sylhare/Type-on-Strap.svg?branch=master)](https://travis-ci.org/sylhare/Type-on-Strap)\n[![Gem Version](https://badge.fury.io/rb/type-on-strap.svg)](https://badge.fury.io/rb/type-on-strap)\n[![Docker Pulls](https://img.shields.io/docker/pulls/sylhare/type-on-strap)](https://hub.docker.com/r/sylhare/type-on-strap)\n\n[![Default Type on Strap blog](https://github.com/Sylhare/Type-on-Strap/blob/master/screenshot.png?raw=true)](https://sylhare.github.io/Type-on-Strap/)\n\nA free and open-source [Jekyll](https://jekyllrb.com) theme. Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme) packed with extra features and easily cusomizable:\n\n* Responsive design on all devices (🖥, 💻, 📱, ...)\n* Portfolio 🗂, Gallery 🖼 pages for your projects\n* Tags compatibility 🏷\n* Handle Bootstrap'ed pages: [Get Bootstrap](http://getbootstrap.com/)\n* 🔎 Search feature: [Simple-Jekyll-Search](https://github.com/christian-fei/Simple-Jekyll-Search)\n* Math Rendering : [KateX](https://github.com/Khan/KaTeX)\n* 🖋 Nice fonts: [Font Awesome](https://fontawesome.com/), [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+Pro), [Pacifico](https://fonts.google.com/specimen/Pacifico?selection.family=Pacifico) \n* Seo Tags: [Jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)\n* 🛠 Syntax Highlighting: Easily customisable [Base16](https://github.com/chriskempson/base16)\n* Free of rights images from [pexels](https://www.pexels.com/)\n\n\u003e [Demo Site](https://sylhare.github.io/Type-on-Strap/)\n\n## Table of Contents\n\n  - [Usage](#usage)\n  - [Structure](#structure)\n  - [Configure Type on Strap](#configure-type-on-strap)\n  - [Other Layouts](#other-layouts)\n  - [Feature pages](#feature-pages)\n  - [Advanced](#advanced)\n  - [License](#license)\n\n## Usage\n\n### As a ruby gem 💎\n\nCheck out this tutorial: [Use as Ruby Gem](https://github.com/Sylhare/Type-on-Strap#use-as-ruby-gem)\n\n### As a github page 📋\n\n1. Fork and clone the [Type on Strap repo](https://github.com/sylhare/Type-On-Strap): `git clone https://github.com/Sylhare/Type-on-Strap.git`\n2. Install [Jekyll](https://jekyllrb.com/docs/installation/): `gem install jekyll`, check [#1](https://github.com/Sylhare/Type-on-Strap/issues/1) if you have a problem.\n3. Install the theme's dependencies: `bundle install`\n4. Customize the theme\n\t- Github Page: [update `_config.yml`](https://github.com/Sylhare/Type-on-Strap#site-configuration)\n5. Run the Jekyll server: `bundle exec jekyll serve`\n\n## Structure\n\nHere are the main files of the template\n\n```bash\nType-on-Strap\n├── _includes\t               # theme includes\n├── _layouts                   # theme layouts (see below for details)\n├── _portfolio\t               # collection of article to be populated in the portfolio page\n├── _posts                     # Blog posts\n├── _sass                      # Sass partials \n├── assets\n|  ├── js\t               # theme javascript, Katex, jquery, bootstrap, jekyll search, \n|  ├── css                     # isolated Bootstrap, font-awesome, katex and main css\n|  ├── fonts\t\t       # Font-Awesome, and other fonts\n|  └── img\t\t       # Images used for the template\n├── pages\n|   ├── 404.md\t\t       # To be displayed when url is wrong\n|   ├── about.md               # About example page\n|   ├── gallery.md             # Gallery page for your photos\n|   ├── portfolio.md\t       # Portfolio page for your projects\n|   ├── search.html\t       # Search page\n|   └── tags.md                # The tag page\n├── _config.yml                # sample configuration\n├── _data.yml\n|  ├── authors.yml             # Update the post authors configurations \n|  ├── language.yml            # Localization configuration\n|  └── social.yml              # Social configurations (RSS, Twitter, ...)\n└── index.html                 # sample home page (blog page paginated)\n```\n\t\n## Configure Type on Strap 🛠\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. \n\n\n### Site configuration\n\nConfigure Jekyll as your own blog or with a \"baseurl\" in in `_config.yml`:\n\nJekyll website *without* a \"baseurl\" (such as a GitHub Pages website for a given username):\n\n```yml\nbaseurl: \"\"\nurl: \"https://username.github.io\"\n```\n\nJekyll website *with* \"baseurl\" (like the Type on Strap [demo](https://sylhare.github.io/Type-on-Strap/) page):\n\n```yml\nbaseurl: \"/sub-directory\"\nurl: \"https://username.github.io/\"\n```\n\nPlease configure this  before using the theme.\n\n### Meta and Branding\n\nMeta variables hold basic information about your Jekyll site which will be used throughout the site \nand as meta properties for search engines, browsers, and the site's RSS feed.\n\nChange these variables in `_config.yml`:\n\n```yml\ntitle: My Jekyll Blog                 # Name of website\navatar: assets/img/triangle.png       # Path of avatar image, to be displayed in the theme's header\ndescription: My blog posts            # Short description, primarily used by search engines\nfavicon: assets/favicon.ico           # Icon displayed in the tab\n```\n\nYou can also customize the seo tags default option following the jekyll-seo-tag plugin [documentation](http://jekyll.github.io/jekyll-seo-tag/advanced-usage/).\n\n### Theme customization 🎨\n\n#### Footer and Header's text\n\nCustomize your site header/footer with these variables in `_config.yml`:\n\n```yml\nheader_text: Welcome to my Jekyll blog\nheader_feature_image: assets/img/sample3.png\nfooter_text: Copyright 2017\n```\n\nIf you don't want anything, replace the value by `\" \"`.\n\n#### Localisation string\n\nLocalization string is a way to quickly change the template language for text like *Next Post* or *Follow on*, ...\nYou can find all the properties in `_data/language.yml`.\n\nBy default it is in english, but you can easily add your own language.\n\n### Google Analytics\n\nTo enable Google Analytics, add your [tracking ID](https://support.google.com/analytics/answer/1032385) \nto `_config.yml` like so:\n\n```yml\ngoogle_analytics: UA-NNNNNNNN-N\n```\n\n### Comments (via Disqus)\n\nOptionally, if you have a [Disqus](https://disqus.com/) account, you can show a \ncomments section below each post.\n\nTo enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208) \nto your project's `_config.yml` file:\n\n```yml\ndisqus_shortname: my_disqus_shortname\n```\n\n### Math typesetting\n\nWhen KateX is set in `_config.yml`:\n\n```yml\nkatex: true # to Enable it\n```\n\nYou can then wrap math expressions with `$$` signs in your posts and make sure you have set the `katex` variable \nin `_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\n### Social icons\n\nIn `_data/social.yml` you can customize the social icons from other wbesite you wish to display in the blog.\nThe site icons come from [Font Awesome](https://fontawesome.com/).\n\n### Cookie consent\n\nYou can add a cookie consent with a disclaimer if you use Google Analytics while respecting the [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation).\nSet to true, there will be a banner at the bottom of the page with the disclaimer and a approve button.\nOnce the user clicks on \"Approve\" the cookies will be created for Google Analytics.\n\n#### Share in article\n\nThe share icons are the one at the bottom of the blog page if enabled, \nto share the article on those platform.\n\n#### Footer\n\nDisplay in the footer. \nAll icon variables should be your username enclosed in quotes (e.g. \"username\") in `_data/social.yml`, \nexcept for the following variables:\n\n```yml\nrss: true                                                   \nemail_address: type@example.com\nlinkedin: https://www.linkedin.com/in/FirstLast\nstack_exchange: https://stackexchangecom/users/0000/first-last\nstack_overflow: https://stackoverflow.com/users/0000/first-last\nyoutube: UCqECaJ8Gagnn7YCbPEzWH6g  # Youtube token of your channel in the url \n```\n\nYou can update the RSS settings in `_data/social` to change the default feed path (generated by [jekyll-feel](https://github.com/jekyll/jekyll-feed)).\n\n### Personalize your Blog Posts 📝\n\nWhen writing a post, be sure in jekyll to:\n - Put it in the `_posts` folder\n - Name it with the date first like `2019-08-21-This-is-my-blog-post.md`\n\nPlease refer to the [Jekyll docs for writing posts](https://jekyllrb.com/docs/posts/). \n\n#### Layout: Post\n\nThis are the basic features you can use with the  `post` layout.\n\n```yml\n\n---\nlayout: post\ntitle: Hello World                                # Title of the page\nhide_title: true                                  # Hide the title when displaying the post, but shown in lists of posts\nfeature-img: \"assets/img/sample.png\"              # Add a feature-image to the post\nthumbnail: \"assets/thumbnails/sample-th.png\"      # Add a thumbnail image on blog view\ncolor: rgb(80,140,22)                             # Add the specified color as feature image, and change link colors in post\nbootstrap: true                                   # Add bootstrap to the page\ntags: [sample, markdown, html]\n---\n```\n\nWith `thumbnail`, you can add a smaller image than the `feature-img`. \nIf you don't have a thumbnail you can still use the same image as the feature one. Or use the gulp task to create it.\n\nThe background used when `color` is set comes from `lineart.png` from [xukimseven](https://github.com/xukimseven) \nyou can edit it in the config file (`_config.yml \u003e color_image`). If you want another one, put it in `/assets/img` as well. \n\nThe **bootstrap** is not mandatory and is only useful if you want to add bootstrapped content in your page. \nIt will respect the page and theme layout, mind the padding on the sides.\n\n#### Post excerpt\n\nThe [excerpt](https://jekyllrb.com/docs/posts/#post-excerpts) are the first lines of an article that is display on the blog page. \nThe length of the excerpt has a default of around `250` characters or can be manually set in the post using:\n\nin `conflig.yml`:\n\n```yml\nexcerpt: true\n```\n\nThen in your post, add the `excerpt separator`:\n\n```yml\n\n---\nlayout: post\ntitle: Sample Page\nexcerpt_separator: \u003c!--more--\u003e\n---\n\nsome text in the excerpt\n\u003c!--more--\u003e\n... rest of the text not shown in the excerpt ...\n```\n\nThe html is stripped out of the excerpt so it only display text.\n\n#### Image aligner\n\nTo easily add align images side by side in your article using the `aligner.html` include:\n\n```ruby\n{% include aligner.html images=\"path/to/img1.png,path/to/img2.png,path/to/img3.png\" column=3 %}\n```\n\nUse it in any markdown file. There are two fields in the include you need to look into:\n  - _images_: Takes a string separated with `,` of all the images path. \n    - It by default look into `assets/img/` so give the path from there.\n  - _column_: (OPTIONAL) Set the number of column you want your imaged displayed in.\n    - default is 2 columns\n    - `column=3` set 3 columns\n    - `column=\"auto\"` makes as many columns as images\n\n#### Code highlight\n\nLike all CSS variables in the theme, you can edit the color of the code highlight in _sass \u003e base \u003e _variables.scss.\nThe code highlighting works with [base16](https://github.com/chriskempson/base16-html-previews/tree/master/css) you can find existing example \nof your favourite highlight color scheme on this format.\n\n## Feature pages and layouts \n\nAll feature pages besides the \"home\" one are stored in the `page` folder, \nthey will appear in the navigation bar unless you set `Hide: true` in the front matter. \n\nHere are the documentation for the other feature pages that can be added through `_config.yml`. \n\nNon-standard features are documented below.\n\n### Layout: Default\n\nThis layout includes the head, navigation bar and footer around your content. \nUnless you're making a custom layout you won't need it.\n\n### Layout: Home 🏡\n\nThis page is used as the home page of the template (in the `index.html`). It displays the list of articles in `_posts`.\nYou can use this layout in another page (adding a title to it will make it appear in the navigation bar).\n\nThe recommended width and height for the home picture is width:`2484px;` and height:`1280px` \nwhich are the dimensions of the actual picture for it to be rolling down as you scroll the page.\n\nIf your posts are not displaying ensure that you have added the line `paginate: 5` to `_config.yml`.\n\n### Layout: Page 📄\n\nThe page layout have a bit more features explained here.\n\n```yml\n\n---\nlayout: page\ntitle: \"About\" \nsubtitle: \"This is a subtitle\"   \nfeature-img: \"assets/img/sample.png\" \npermalink: /about.html               # Set a permalink your your page\nhide: true                           # Prevent the page title to appear in the navbar\nicon: \"fa-search\"                    # Will Display only the fontawesome icon (here: fa-search) and not the title\ntags: [sample, markdown, html]\n---\n```\n\nThe hide only hides your page from the navigation bar, it is however still generated and can be access through its link. \n\n### Feature: Portfolio 🗂\n\nPortfolio is a feature page that will take all the markdown/html files in the `_portfolio` folder to create a 3-columns image portfolio matrix.\n\nTo use the portfolio, simply create a `portfolio.md` with this information inside:\n\n```yml\n\n--- \nlayout: page\ntitle : Portfolio \n---\n\n{% include portfolio.html %}\n```\n\n#### Portfolio posts\n\nYou can format the portfolio posts in the `_portfolio` folder using the `post layout`. Here are little explaination on some of the possible feature you can use and what they will do.\n\nIf you decide to use a date, please be sure to use one that can be parsed such as `yyyy-mm-dd`. You can see more format example on the demo posts that are available for the theme:\n\n```yml\n\n---\nlayout: post\ntitle: Circus\t\t\t\t       # Title of the portfolio post\nfeature-img: \"assets/img/portfolio/cake.png\"   # Will display the image in the post\nimg: \"assets/img/portfolio/cake.png\"           # Will display the image in the portfolio page\ndate: 2019-07-25\t\t \t       # Not mandatory, however needs to be in date format to display the date\n---\n```\n\n#### Portfolio in gem\n\nMake sure your `_config.yml` contains the following if you are using the theme as a gem:\n\n```yml\n# PORTFOLIO\ncollections:\n  portfolio:\n    output: true\n    permalink: /:collection/:name\n```    \n\nThis creates the collection for Jekyll so it can find and display your portfolio posts.\n\n### Feature: Gallery 🖼\n\nYou can create a gallery using [Masonry JS](https://masonry.desandro.com/) which will placing the pictures in optimal position \nbased on available vertical space. \nYou need to specify the `gallery_path` which will be used to find the pictures to render. \nIt will take all of the picture under that directory. Then use the `include` to add it in your page. \n\n```yml\n\n---\nlayout: page\ntitle: Gallery\ngallery: \"assets/img/pexels\"\n---\n\n{% include gallery.html gallery_path=page.gallery %}\n```\n\n\n### Feature: Search 🔍\n\nThe search feature is based on [Simple-Jekyll-search](https://github.com/christian-fei/Simple-Jekyll-Search) \nthere is a `search.json` file that will create a list of all of the site posts, pages and portfolios. \n\nThen there's a `search.js` displaying the formatted results entered in the `search.html` page.\n\nThe search page can be hidden with the `hide` option. You can remove the icon by removing `icon`:\n\n```yml\n\n---\nlayout: search\ntitle: Search\nicon: \"search\"\n---\n```\n\n### Feature: Tags 🏷\n\nTags should be placed between `[]` in your post metadata. Separate each tag with a comma. \nTags are recommended for posts and portfolio items.\n\nFor example:\n\n```yml\n\n---\nlayout: post\ntitle: Markdown and HTML\ntags: [sample, markdown, html]\n---\n```\n\n\u003e Tags are case sensitive `Tag_nAme` ≠ `tag_name`\n\nAll the tags will be listed in `tags.html` with a link toward the pages or posts.\nThe Tag page can be hidden with the `hide` option. You can remove the icon by removing `icon` (like for the search page).\n\n## Advanced\n\n### Liquid tags\n\nJekyll works with [liquid](https://shopify.github.io/liquid/) tags usually represented by:\n\n```\n{{ liquid.tag | filter }}\n```\n\nThese are useful to render your jekyll files. \nYou can learn more about them on [shopify's doc](https://help.shopify.com/themes/liquid/basics)\n\n### Minimizing and optimizing: css, js and images\n\nBefore you need to have *node* and `npm` installed:\n\n- Windows: https://nodejs.org/\n- Ubuntu/Debian: `apt-get install nodejs npm libgl1 libxi6`\n- Fedora (dnf) / RHEL/CentOS (yum): `dnf install node npm libglvnd-glx libXi`\n\nThen you need to install [`gulp-cli`](https://gulpjs.com/) and its dependencies:\n\n```bash\ncd assets/\nsudo npm install gulp-cli -g\nnpm install\n```\n\nYou can run the default task that will compress the js, css and images and create the thumbnails for the supported image\nformats:\n\n```bash\ncd assets/\ngulp default\ngulp thumbnails # to create all of the images thumbnails\n# tip: run a git status to see the changes\ngit status\n```\n\nYou can find more about the gulp tasks in the [gulpfile.js](assets/gulpfile.js)\n\n### Use as Ruby Gem 💎\n\nYou can use Type-on-strap as a [gem](https://rubygems.org/gems/type-on-strap). \n\nRuby Gem Method\nAdd this line to your Jekyll site's Gemfile (or create one):\n\n```ruby\ngem \"type-on-strap\"\n```\n\nAdd this line to your Jekyll site's `_config.yml` file:\n\n```yml\ntheme: type-on-strap\n```\n\nThen run Bundler to install the theme gem and dependencies:\n\n```bash\nbundle install\n```\n\nThen you can start adding content like:\n  - Add a `index.html` file\n  - Add the feature page you want. (ex: as it is already in `pages`)\n  - Add posts in `_posts` and `_portfolio` to be displayed\n\n### Remote Theme\n\nNow you can use any theme gem with github pages with [29/11/2017 Github Pages Broadcast](https://github.com/blog/2464-use-any-theme-with-github-pages).\nFor that remove all `theme:` attributes from `_config.yml` and add instead:\n\n```yml\nremote_theme: sylhare/Type-on-Strap \n```\n\n## License\n\nThis theme is licensed under the [The MIT License (MIT)](https://raw.githubusercontent.com/Sylhare/Type-on-Strap/master/LICENSE)\n\n- Pictures from [Pexels](https://www.pexels.com/) are under Creative Commons Zero (CC0) license\n- Fonts are licensed under the [SIL Open Font License (OFL)](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi\u0026id=OFL) \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/nlp4prog.github.io%2F2021%2F","html_url":"https://awesome.ecosyste.ms/projects/nlp4prog.github.io%2F2021%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/nlp4prog.github.io%2F2021%2F/lists"}