{"id":15679606,"url":"https://github.com/dreikanter/markdown-grid","last_synced_at":"2025-05-07T10:04:41.673Z","repository":{"id":3681237,"uuid":"4751049","full_name":"dreikanter/markdown-grid","owner":"dreikanter","description":"Twitter Bootstrap compatible grid extension for markdown syntax.","archived":false,"fork":false,"pushed_at":"2017-10-27T10:45:05.000Z","size":65,"stargazers_count":11,"open_issues_count":3,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-25T23:51:14.726Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dreikanter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-06-22T12:54:11.000Z","updated_at":"2023-08-28T14:30:01.000Z","dependencies_parsed_at":"2022-09-15T16:10:35.335Z","dependency_job_id":null,"html_url":"https://github.com/dreikanter/markdown-grid","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreikanter%2Fmarkdown-grid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreikanter%2Fmarkdown-grid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreikanter%2Fmarkdown-grid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreikanter%2Fmarkdown-grid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dreikanter","download_url":"https://codeload.github.com/dreikanter/markdown-grid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242945524,"owners_count":20210762,"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-03T16:33:31.429Z","updated_at":"2025-03-10T23:33:36.999Z","avatar_url":"https://github.com/dreikanter.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Grid Extension\n\nThis is [Markdown](http://daringfireball.net/projects/markdown/) extension\nfor grid building. It provides minimal and straightforward syntax to create\nmulticolumn text layouts. By default the extension generates [Twitter\nBootstrap](http://twitter.github.com/bootstrap/) compatible HTML code but\nit is intended to be template-agnostic. It could be configured to use any other\nHTML/CSS framework (e.g. [Skeleton](http://getskeleton.com)) or custom design.\n\n\n## The Syntax\n\nMarkdown syntax extension is pretty simple. Page source example below defines\na threee-column page fragment:\n\n```markdown\n-- row 5, 2, 5 --\nFirst column contains couple of paragraphs. Lorem ipsum dolor sit amet,\nconsectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore\net dolore magna aliqua.\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi\nut aliquip ex ea commodo consequat.\n---\nSome images in the middle column:\n![One](image-1.png)\n![Two](image-2.png)\n---\nAnd some **more** text in the _third_ column. Duis aute irure dolor in\nreprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.\n\n[Excepteur](http://excepteur.org ) sint occaecat cupidatat non proident, sunt\nin culpa qui officia deserunt mollit anim id est laborum.\n-- end --\n```\n\nComma separated list of numbers after the `row` instruction is an optional\ndefinition for columns width. This example uses 12-column Twitter Bootstrap\ngrid, so \"5, 2, 5\" corresponds to \"41.5%, 17%, 41.5%\" relatively to the total\npage width.\n\n\n## Processing\n\nGrid extension uses two-stage processing flow:\n\n1. On the first stage text preprocessor generates markdown-friendly tags based\non the original minimalistic syntax. Those tags are explicit instructions for\nfurther layout building enclosed with HTML comments.\n2. Second stage takes place after Markdown general processing. Extension\npostprocessor replaces previously-inserted tags with actual HTML markup.\n\nYou will never see the intermediate page source processing result, but this\ndocument use to be some kind of technical specification, so the details should\nbe described anyway.\n\nHere is preprocessor output for the initial example:\n\n```html\n\u003c!--mdtb:row,col4--\u003e\n\nFirst column contains couple of paragraphs. Lorem ipsum dolor sit amet,\nconsectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore\net dolore magna aliqua.\n\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi\nut aliquip ex ea commodo consequat.\n\n\u003c!--mdtb:endcol,col4--\u003e\n\nSome images in the middle column:\n\n![One](image-1.png)\n\n![One](image-1.png)\n\n\u003c!--mdtb:endcol,col4--\u003e\n\nAnd some **more** text in the _third_ column. Duis aute irure dolor in\nreprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.\n\n[Excepteur](http://excepteur.org) sint occaecat cupidatat non proident, sunt\nin culpa qui officia deserunt mollit anim id est laborum.\n\n\u003c!--mdtb:endcol,endrow--\u003e\n```\n\nThe final result (as it was mentioned already it is based on Twitter\nBootstrap):\n\n```html\n\u003cdiv class=\"row\"\u003e\n\t\u003cdiv class=\"span5\"\u003e\n\t\t\u003cp\u003eFirst column contains couple of paragraphs. Lorem ipsum dolor sit\n\t\tamet, consectetur adipisicing elit, sed do eiusmod tempor incididunt\n\t\tut labore et dolore magna aliqua.\u003c/p\u003e\n\t\t\u003cp\u003eUt enim ad minim veniam, quis nostrud exercitation ullamco laboris\n\t\tnisi ut aliquip ex ea commodo consequat.\u003c/p\u003e\n\t\u003c/div\u003e\n\t\u003cdiv class=\"span2\"\u003e\n\t\t\u003cp\u003eSome images in the middle column:\u003c/p\u003e\n\t\t\u003cp\u003e\u003cimg alt=\"One\" src=\"image-1.png\" /\u003e\u003c/p\u003e\n\t\t\u003cp\u003e\u003cimg alt=\"One\" src=\"image-1.png\" /\u003e\u003c/p\u003e\n\t\u003c/div\u003e\n\t\u003cdiv class=\"span5\"\u003e\n\t\t\u003cp\u003eAnd some \u003cstrong\u003emore\u003c/strong\u003e text in the \u003cem\u003ethird\u003c/em\u003e column.\n\t\tDuis aute irure dolor in reprehenderit in voluptate velit esse cillum\n\t\tdolore eu fugiat nulla pariatur.\u003c/p\u003e\n\t\t\u003cp\u003e\u003ca href=\"http://excepteur.org\"\u003eExcepteur\u003c/a\u003e sint occaecat\n\t\tcupidatat non proident, sunt in culpa qui officia deserunt mollit\n\t\tanim id est laborum.\u003c/p\u003e\n\t\u003c/div\u003e\n\u003c/div\u003e\n```\n\n## Installation\n\nA command to install markdown-grid:\n\n\tpip install -e git+git://github.com/dreikanter/markdown-grid#egg=mdx_grid\n\nIncluding markdown-grid to a package:\n\n\tsetup(\n\t    name='example',\n\t    ...\n\t    install_requires=[\n\t        'markdown',\n\t        'mdx_grid',\n\t        ...\n\t    ],\n\t    dependency_links=[\n\t        'https://github.com/dreikanter/markdown-grid/tarball/master#egg=mdx_grid'\n\t    ],\n\t)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreikanter%2Fmarkdown-grid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdreikanter%2Fmarkdown-grid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreikanter%2Fmarkdown-grid/lists"}