{"id":14235565,"url":"https://github.com/eggcaker/jekyll-org","last_synced_at":"2025-04-09T05:11:56.661Z","repository":{"id":2120468,"uuid":"3062967","full_name":"eggcaker/jekyll-org","owner":"eggcaker","description":"org-mode  converter for Jekyll.","archived":false,"fork":false,"pushed_at":"2024-09-10T02:48:18.000Z","size":95,"stargazers_count":132,"open_issues_count":12,"forks_count":29,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-12T14:05:39.055Z","etag":null,"topics":["jekyll","org-mode"],"latest_commit_sha":null,"homepage":"http://eggcaker.github.io/jekyll-org","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"joeldev/JLRoutes","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eggcaker.png","metadata":{"files":{"readme":"README.org","changelog":"History.md","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":"2011-12-28T14:17:40.000Z","updated_at":"2024-09-10T02:48:22.000Z","dependencies_parsed_at":"2024-09-10T05:57:55.812Z","dependency_job_id":"4f647f52-6154-4cff-8f96-c427200b438d","html_url":"https://github.com/eggcaker/jekyll-org","commit_stats":{"total_commits":71,"total_committers":19,"mean_commits":3.736842105263158,"dds":"0.47887323943661975","last_synced_commit":"0bbf76e6202f701bc8f0a0e0b670dc5ef89fdce2"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggcaker%2Fjekyll-org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggcaker%2Fjekyll-org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggcaker%2Fjekyll-org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggcaker%2Fjekyll-org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eggcaker","download_url":"https://codeload.github.com/eggcaker/jekyll-org/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980844,"owners_count":21027808,"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":["jekyll","org-mode"],"created_at":"2024-08-20T21:02:06.046Z","updated_at":"2025-04-09T05:11:56.630Z","avatar_url":"https://github.com/eggcaker.png","language":"Ruby","readme":"* jekyll-org\n\n*Looking for a New Maintainer*\n \n*Notice*: I am currently not really using ruby and jekyll right now, and I am looking for someone who is interested and willing to take over its maintenance. If you're interested, please contact me using one of the methods below:\nSend an email to: eggcaker@gmail.com\nLeave a message in the issues.\n\n** Overview\n\nThis plugin adds [[http://orgmode.org/][Org mode]] support to [[http://jekyllrb.com][Jekyll]] and lets you write posts\nand pages in Org.\n\n** Related Projects \n   \nWhat's the difference with org2jekll \nYou don’t need to any org-publish-project-alist to starting write post, just start with any editor that org-mode supported\n\nWhat’s the difference with org-jekyll?\nYou don’t need to add some alien yaml in your org-mode file. You add specific org-mode headers and this will be used to format the jekyll post.\n\nWhat’s the difference with happyblogger?\nNo more external ruby script. \n\n** Requirements\n\n- Jekyll\n- org-ruby\n\n** Installation\n*** Short version\n\nFor experienced Jekyll users, you need to do 2 things to get\n~jekyll-org~ to work :\n\n- Include the gem in your ~_config.yml~\n- Include the gem in Gemfile\n\n*** Long version\n\nTo use ~jekyll-org~ with Jekyll, you need to have Ruby RubyGems and\nJekyll installed.  See how to do that [[http://jekyllrb.com/docs/installation/][here]].\n\nCreate a new Jekyll project ~my-site~ run:\n\n#+begin_src sh\njekyll new my-site\n#+end_src\n\nCreate a Gemfile in the root of the project, and add at least the\nfollowing lines:\n\n#+begin_src ruby\nsource 'https://rubygems.org'\n\ngem 'jekyll' , '\u003e= 3.0.0'\ngem 'jekyll-org', '\u003e= 1.1.0'\n#+end_src\n\nInstall the gems with bundler:\n\n#+begin_src sh\nbundle install\n#+end_src\n\nTo use the new converter add the following line to your ~_config.yml~:\n\n#+begin_src yml\nplugins:\n  - jekyll-org\n#+end_src\n\n:warning: If you are using Jekyll \u003c 3.5.0 use the gems key instead of plugins.\n\n** Usage\n\nCreate a new file with =.org= extension in =_posts=, and write the post\nwith Org. That is all! Generate your Jekyll site as you usually do.\n\n** Front matter\n\nInstead of YAML the front matter is configured in the usual Org way,\nwith no lines.   \n\nBelow is an example of an Org post, featuring front matter, tags, tables,\nliquid templating and syntax highlighting. To render this example, remove\nthe leading hash symbols (#) at =#+begin_src= and =#+begin_end= beforehand\n(this is a workaround for GitHub's org rendering).\n\n#+BEGIN_EXAMPLE\n#+TITLE: Jekyll and Org together\n#+LAYOUT: post\n#+TAGS: jekyll org-mode \"tag with spaces\"\n\nThis is a blog post about Jekyll and Org mode.\n\n** org-table demo \n\n   | a | b | c | d | e |\n   |---+---+---+---+---|\n   | 1 | 2 | 3 | 4 | 5 |\n\n** Liquid demo \n   #+liquid: enabled\n   #+foo: hello world\n   {{ page.foo }}\n\n   or\n\n   {{ site.time | date_to_xmlschema }}\n   \n** Code highlighting\n   Jekyll-org also offers powerful support for code snippets:\n   ##+begin_src  ruby \n     def print_hi(name)\n       puts \"Hi, #{name}\"\n     end\n     print_hi('Tom')\n\n     #=\u003e prints 'Hi, Tom' to STDOUT.\n   ##+end_src\n#+END_EXAMPLE\n\nThe value of =#+TAGS= is parsed into a list by splitting it on spaces,\ntags containing spaces can be wrapped into quotes.\n\n** Liquid templating\n\nBy default the all content is exported to raw HTML with org-ruby, but\nyou can add =#+liquid: whatevervalue== in the header.  Then you can use\n[[http://docs.shopify.com/themes/liquid-documentation/basics][Liquid]] tags.\n\nFor example, if your Org file contains\n\n#+BEGIN_EXAMPLE\n#+liquid: enabled\n#+foo: hello world\n\n{{ page.foo }}\n\nor\n\n{{ site.time | date_to_xmlschema }}\n\n#+END_EXAMPLE\n\nthen you will get output like\n\n#+BEGIN_EXAMPLE\n\u003cp\u003ehello world\u003c/p\u003e\n\u003cp\u003eor\u003c/p\u003e\n\u003cp\u003e2014-07-02T08:20:28+08:00\u003c/p\u003e\n#+END_EXAMPLE\n\n*** Site wide config\n\nAlternatively, if you'd rather enable liquid by default for every\norg file being converted, you can enable it in your /_config.yml/\nfile.\n\n#+BEGIN_EXAMPLE\norg:\n  liquid: true\n#+END_EXAMPLE\n\n** Source code highlighting\n\nTo enable source code highlighting, run =bundle add pygments.rb=. If your Jekyll\ntheme has built-in support for syntax highlighting, you're all set! Otherwise, add a =pygments=-compatible\nCSS file to your site's =/assets/css/= folder. You can find a bunch of CSS themes for =pygments= in\n[[https://github.com/richleland/pygments-css][this repository]], or create your own (some related =pygments= documentation is [[https://pygments.org/docs/styles/][here]]).\n\nThen, add a source code block as you would in Org, for example Ruby:\n\n#+BEGIN_EXAMPLE\n#+BEGIN_SRC\n require 'rubygems'\n require 'org-ruby'\n data = IO.read(filename)\n puts Orgmode::Parser.new(data).to_html\n#+END_SRC\n#+END_EXAMPLE\n\nAnd the output will have code highlighting:\n\n#+BEGIN_SRC ruby\n require 'rubygems'\n require 'org-ruby'\n data = IO.read(filename)\n puts Orgmode::Parser.new(data).to_html\n#+END_SRC\n\n** Author\n\neggcaker \u003ceggcaker@gmail.com\u003e\n\n** License\n\nMIT\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feggcaker%2Fjekyll-org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feggcaker%2Fjekyll-org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feggcaker%2Fjekyll-org/lists"}