{"id":15612495,"url":"https://github.com/kylefox/kirby-old","last_synced_at":"2025-09-10T12:42:32.811Z","repository":{"id":1184898,"uuid":"1086269","full_name":"kylefox/kirby-OLD","owner":"kylefox","description":"** This repo has been abandoned in favour of a new one (private for now) **","archived":false,"fork":false,"pushed_at":"2011-02-18T05:40:59.000Z","size":362,"stargazers_count":12,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-28T13:03:41.173Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kylefox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-11-16T20:12:49.000Z","updated_at":"2014-01-31T02:58:02.000Z","dependencies_parsed_at":"2022-08-16T12:30:34.157Z","dependency_job_id":null,"html_url":"https://github.com/kylefox/kirby-OLD","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylefox%2Fkirby-OLD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylefox%2Fkirby-OLD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylefox%2Fkirby-OLD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kylefox%2Fkirby-OLD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kylefox","download_url":"https://codeload.github.com/kylefox/kirby-OLD/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251319612,"owners_count":21570426,"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-10-03T06:43:14.824Z","updated_at":"2025-04-28T13:05:27.578Z","avatar_url":"https://github.com/kylefox.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"A tiny little Python app that compiles [Markdown](http://daringfireball.net/projects/markdown/syntax) + [Jinja2](http://jinja.pocoo.org/) into static HTML and (optionally) uploads it to [Amazon S3](http://aws.amazon.com/s3/).\n\n_Kirby is still in it's infancy.  Be aware that the API could change dramatically until the first release._\n\nInstalling\n----------\n\nKirby is installable with pip (recommended):\n\n    $ pip install git+git://github.com/kylefox/kirby.git\n    \nYou can also clone the repository and install:\n\n    $ git clone git://github.com/kylefox/kirby.git\n    $ cd kirby\n    $ python setup.py install\n    \nCreating a Kirby site\n---------------------\n\nYou create a new Kirby site with\n\n    $ kirby new example.com\n\nwhich creates the resulting directory structure:\n\n* example.com\n  * _public\n  * content\n  * media\n  * templates\n  \nHere is the purpose of each directory:\n\n* **_public** contains your compiled Kirby site after you publish it.  You should not modify this folder's contents.\n* **content** contains your Markdown files (pages \u0026 blog posts).\n* **media** contains images, CSS, JavaScript, and other static media.\n* **templates** contains your Jinja2 template files.\n\n    \n    \nRunning the development server\n------------------------------\n\nAfter creating your site, spark up the development server:\n\n    $ cd example.com\n    $ kirby serve\n    \nThe development server compiles your markdown and templates on the fly.  This is useful while you're working on the site design and for previewing content.\n\nCreating pages\n--------------\n\nA **Page** is simply a markdown file located inside the `content` directory.  The URL to the page is the file path (relative to `content`) with the .md extension stripped.\n\nSome examples:\n\n* `content/about.md` is served at **http://localhost:8000/about**\n* `company/team/sammy.md` is be served at **http://localhost:8000/company/team/sammy**\n\nThe only exception to this convention is the index page:\n\n* `content/index.md` is served at **http://localhost:8000/**\n \nTemplate Context\n----------------\n\nInside your templates you can access your page data through the `page` context object. This object contains all dynamic YAML fields from your markdown file, as well as a `content` field taken from all content after the `- - -` delimiter.\n\nSome examples:\n\n* `{{ page.title }}` is a string mapped from the YAML element `title: My Title`\n* `{{ page.date }}` is date mapped from the YAML element `date: date: 2010-11-16`\n\nWith the exception being the content:\n\n* `{{ page.content }}` contains the markdown-rendered HTML content of your page\n\nUploading to Amazon S3\n----------------------\n\nOnce you're happy with the current state of your site, you can generate static HTML files and upload them to Amazon S3.\n\nFirst, make sure you've set these environment variables. A good place is in your `~/.profile`\n\n    AWS_ACCESS_KEY_ID='Your Access Key'\n    AWS_SECRET_ACCESS_KEY='Your Secret Key'\n\nThen you need to create an S3 bucket (you only need to do this once):\n\n    $ kirby aws\n    \nNow whenever you want to upload your Kirby site to S3, just run:\n\n    $ kirby s3\n\n\nRunning Tests\n-------------\n\nWe use [nose](http://somethingaboutorange.com/mrl/projects/nose/0.11.2/) to test Kirby:\n\n    $ git clone git://github.com/kylefox/kirby.git\n    $ cd kirby\n    $ nosetests\n\nContributing\n------------\n\nPlease fork and send pull requests.\n\nIf you want something to work on, see our [issues](https://github.com/kylefox/kirby/issues) list.  We can also use help with:\n\n* Tests\n* Documentation\n* Template tags\n    * Fetching content (ex: show 5 blog posts on homepage)\n    * Site-wide variables (site name, admin email, etc).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylefox%2Fkirby-old","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkylefox%2Fkirby-old","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkylefox%2Fkirby-old/lists"}