{"id":15201544,"url":"https://gitlab.com/redhwannacef/simport","last_synced_at":"2025-10-28T18:31:49.935Z","repository":{"id":56895891,"uuid":"13232709","full_name":"redhwannacef/simport","owner":"redhwannacef","description":"A simple portfolio and blog theme for jekyll.","archived":false,"fork":false,"pushed_at":null,"size":null,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":null,"default_branch":"master","last_synced_at":"2025-02-01T17:34:12.961Z","etag":null,"topics":["jekyll","jekyll-theme","jekyll-themes","simport"],"latest_commit_sha":null,"homepage":null,"language":null,"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":null,"metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-09T07:45:20.754Z","updated_at":"2019-07-26T11:26:09.890Z","dependencies_parsed_at":"2022-08-20T17:10:16.086Z","dependency_job_id":null,"html_url":"https://gitlab.com/redhwannacef/simport","commit_stats":null,"previous_names":[],"tags_count":11,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/repositories/redhwannacef%2Fsimport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/repositories/redhwannacef%2Fsimport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/repositories/redhwannacef%2Fsimport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/repositories/redhwannacef%2Fsimport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/owners/redhwannacef","download_url":"https://gitlab.com/redhwannacef/simport/-/archive/master/simport-master.zip","host":{"name":"gitlab.com","url":"https://gitlab.com","kind":"gitlab","repositories_count":4517650,"owners_count":6747,"icon_url":"https://github.com/gitlab.png","version":null,"created_at":"2022-05-30T11:31:42.605Z","updated_at":"2024-07-18T11:24:13.055Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/gitlab.com/owners"}},"keywords":["jekyll","jekyll-theme","jekyll-themes","simport"],"created_at":"2024-09-28T03:05:34.225Z","updated_at":"2025-10-28T18:31:49.156Z","avatar_url":null,"language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# simport\n\nA **sim**ple **por**tfolio and blog theme for jekyll.\n\n## Getting Started\n\nCreate a new directory and run the `jekyll new {site name}` command. \n\nAdd the following to your Jekyll site's `Gemfile` (see below for explanation on the plugins):\n\n```ruby\ngem 'simport', '~\u003e 1.3' # check here for the latest version: https://rubygems.org/gems/simport\n```\n\nThen add this line to your Jekyll site's `_config.yml`. (The plugins are automatically added by the theme):\n\n```yaml\nplugins:\n  - jekyll-feed\n  - jekyll-sitemap\n  - jekyll-seo-tag\n  - jekyll-remote-theme\nremote_theme: redhwannacef/simport\n```\n\nFinally add an `index.md` with the following:\n```\n---\nlayout: home\n---\n```\n\nAnd then execute:\n\n    $ bundle\n    $ bundle exec jekyll serve\n\n## Usage\n\n### Homepage\n\nTo get started you must have a homepage. This is done with by adding either an `index.md` or `index.html` file in the root directory. There is a home layout below that was designed for this page. \n\n### Adding a logo\n\nThere is a default logo in the navbar at the top left of the page. This can be overridden by creating an `_includes/logo.html` file.\n\n### Adding a top level page\n\nYou can add a top level page with two steps.\n\n1. Add a navigation button: create a `_data/navigation.yml` file. This is in the format of a list with a name (to be displayed) and a link to the page. For example:\n```\n- name: About\n  link: /about/\n```\n\n2. Add the page:  create a `_pages/{link}.md` file, where {link} is the link defined above without the forward slashes `/`. In this example it would be `_pages/about.md`. Pick a layout, add a permalink with the same value as the link and optionally add a title for the page. E.g:\n```\n---\nlayout: home\npermalink: '/about/'\ntitle: 'About'\n---\nHello World!\n```\n\n### Layouts\n\n#### home\n\nThis layout is designed for the homepage. Simply an centered area for introduction text.\n\n#### blog/post\n\nThis is a standard blog layout, listing all blog posts, date and excerpt (the first paragraph) found in the `_posts`. The posts should be name in the format `YYYY-MM-DD-{name}.md` for example `2018-08-20-bananas.md`. The posts should use the `posts` layout with the following liquid variables: title, author and date. For example: \n```\n---\nlayout: post\ntitle:  Bananas\nauthor: Alice\ndate: 2018-08-20\n---\n```\n#### tils/posts\n\nThis the same as the blogs layout but looks for posts in the `_tils` directory. The name of this file does not need to include the date. The posts in here should be in the same format as the blogs with one exception, there will need to be an additional variable `excerpt` with the desired excerpt in the post. For example:\n```\n---\nlayout: post\ntitle:  Bananas\nauthor: Alice\ndate: 2018-08-20\nexcerpt: An intro to bananas\n---\n```\n\nNote: By default jekyll knows to look for blog/posts. For TILs, one additionaly configuration is required. Add the following to the `_config.yml`:\n```\ncollections:\n  tils:\n    output: true\n```\n\n#### page\n\nThis is the layout that includes the navbar. This has no styling and can be used for any cusom pages.\n\n## Plugins\n\nThese three official plugins are useful Jekyll sites and are required to get started:\n\n[jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) - Creates a sitemap file to help search engines index content\n\n[jekyll-feed](https://github.com/jekyll/jekyll-feed) - Creates an RSS feed for your posts\n\n[jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) - Adds meta tags to help with SEO\n\n## Enabling Google Analytics\n\nTo enable Google Analytics, add the following lines to your Jekyll site:\n\n```\ngoogle_analytics: UA-NNNNNNNN-N\n```\n\nGoogle Analytics will only appear in production, i.e., JEKYLL_ENV=production\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## Development\n\nTo set up your environment to develop this theme, run `bundle install`.\n\nYour theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.\n\nWhen your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.\nTo add a custom directory to your theme-gem, please edit the regexp in `simport.gemspec` accordingly.\n\n## License\n\nThe theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/gitlab.com%2Fredhwannacef%2Fsimport","html_url":"https://awesome.ecosyste.ms/projects/gitlab.com%2Fredhwannacef%2Fsimport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/gitlab.com%2Fredhwannacef%2Fsimport/lists"}