{ "info": { "author": "Daniil Minukhin", "author_email": "ddddsa@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "[![](https://img.shields.io/pypi/v/foliantcontrib.slate.svg)](https://pypi.org/project/foliantcontrib.slate/)\n\n# Slate Backend for Foliant\n\nSlate backend generates API documentation from Markdown using [Slate docs generator](https://github.com/lord/slate).\n\nThis backend operates two targets:\n\n* `site` \u2014 build a standalone website;\n* `slate` \u2014 generate a slate project out from your Foliant project.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.slate\n```\n\n## Usage\n\nTo use this backend Slate should be installed in your system. Follow the [instruction](https://github.com/lord/slate#getting-set-up) in Slate repo.\n\nTo test if you've installed Slate properly head to the cloned Slate repo in your terminal and try the command below. You should get similar response.\n\n```bash\n$ bundle exec middleman\n== The Middleman is loading\n== View your site at ...\n== Inspect your site configuration at ...\n```\n\nTo convert Foliant project to Slate:\n\n```bash\n$ foliant make slate\n\u2714 Parsing config\n\u2714 Making slate\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nResult: My_Project-2018-09-19.src/\n```\n\nBuild a standalone website:\n\n```bash\n$ foliant make site\n\u2714 Parsing config\n\u2714 Making site\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nResult: My_Project-2018-09-19.slate/\n```\n\n## Config\n\nYou don't have to put anything in the config to use Slate backend. If it is installed, Foliant detects it.\n\nTo customize the output, use options in `backend_config.slate` section:\n\n```yaml\nbackend_config:\n slate:\n shards: data/shards\n header:\n title: My API documentation\n language_tabs:\n - xml: Response example\n search: true\n```\n\n`shards`\n: Path to the shards directory relative to Foliant project dir or list of such paths. Shards allow you to customize Slate's layout, add scripts etc. More info on shards in the following section. Default: `shards`\n\n`header`\n: Params to be copied into the beginning of Slate main Markdown file `index.html.md`. They allow you to change the title of the website, toggle search and add language tabs. More info in [Slate Wiki](https://github.com/lord/slate/wiki).\n\n## About shards\n\nShards is just a folder with files which will be copied into the generated Slate project replacing all files in there. If you follow the Slate project structure you can replace stylesheets, scripts, images, layouts etc to customize the view of the resulting site.\n\nIf shards is a string \u2014 it is considered a path to single shards directory relative to Foliant project dir:\n```\nslate:\n shards: 'data/shards'\n```\n\nIf shards is a list \u2014 each list item is considered as a shards dir. They will be copied into the Slate project subsequently with replace.\n\n```\nslate:\n shards:\n - 'common/shards'\n - 'custom/shards'\n - 'new_design'\n```\n\nFor example, I want to customize standard Slate stylesheets. I look at the Slate repo and see that they lie in the folder `/source/stylesheets`. I create new stylesheets with the same names as the original ones and put them into my shards dir like that:\n\n```\nshards\\\n source\\\n stylesheets\\\n _variables.scss\n screen.css.scss\n```\n\nThese stylesheets will replace the original ones in the Slate project just before the website is be baked. So the page will have my styles in the end.\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/foliant-docs/foliantcontrib.slate", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "foliantcontrib.slate", "package_url": "https://pypi.org/project/foliantcontrib.slate/", "platform": "any", "project_url": "https://pypi.org/project/foliantcontrib.slate/", "project_urls": { "Homepage": "https://github.com/foliant-docs/foliantcontrib.slate" }, "release_url": "https://pypi.org/project/foliantcontrib.slate/1.0.8/", "requires_dist": [ "foliant (>=1.0.8)", "PyYAML", "foliantcontrib.meta (>=1.3.0)" ], "requires_python": "", "summary": "Slate backend for Foliant documentation generator.", "version": "1.0.8", "yanked": false, "yanked_reason": null }, "last_serial": 13654908, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "8294e114e41ffe97c5aefe22a7da4db0", "sha256": "3cdfa5285d2095a80a2268d85a15cab983d619647f80dce6722ebf6f1e3b47bf" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "8294e114e41ffe97c5aefe22a7da4db0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4048, "upload_time": "2018-09-20T09:38:47", "upload_time_iso_8601": "2018-09-20T09:38:47.310822Z", "url": "https://files.pythonhosted.org/packages/70/d7/997fe49ff39966626be7ae80b3ed87e3ab15769c070eb1c3694dcf4216f8/foliantcontrib.slate-1.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "ceb0cd9c60a36e37e2800cbd5d007c02", "sha256": "27eac0a8e49115d3b5e7d2783925cdf78e545ac424aeb6098f7c48bdfcaf07f1" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.0.tar.gz", "has_sig": false, "md5_digest": "ceb0cd9c60a36e37e2800cbd5d007c02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3916, "upload_time": "2018-09-20T09:38:48", "upload_time_iso_8601": "2018-09-20T09:38:48.760215Z", "url": "https://files.pythonhosted.org/packages/7d/87/cf8863085e7a3b1ce9c98e2f9ae80efc68ecce486fa897be254ae934f602/foliantcontrib.slate-1.0.0.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "2da83fb54ceff40923a1e2f94f12fc3a", "sha256": "8aaca27a95980289ee6819680499d7972617e6fe8d6f69e8a752e052e71d1ada" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2da83fb54ceff40923a1e2f94f12fc3a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4784, "upload_time": "2018-09-20T13:54:10", "upload_time_iso_8601": "2018-09-20T13:54:10.359696Z", "url": "https://files.pythonhosted.org/packages/7a/16/4749a08936f03b9237645814fb3bfafa4d5721d8a63ba77090223c1ae834/foliantcontrib.slate-1.0.1-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "a422aa1b311e4544bbbe068c1d7744d8", "sha256": "1aec6eb94b9c8d987605420789449cdfa57615c916dec1624d9133765d15f0ef" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.1.tar.gz", "has_sig": false, "md5_digest": "a422aa1b311e4544bbbe068c1d7744d8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4704, "upload_time": "2018-09-20T13:54:11", "upload_time_iso_8601": "2018-09-20T13:54:11.669749Z", "url": "https://files.pythonhosted.org/packages/16/a4/e620ef6bc2afa703bd1d752380b3d82e7425419fc0dfd1e5c0a081f638ff/foliantcontrib.slate-1.0.1.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "53f7aea06d11c78ab383b41adbcdf77b", "sha256": "7897216324370ac7c94149c037b23b1ff05119ab06c9b2a24b4460ac17f3f4cd" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "53f7aea06d11c78ab383b41adbcdf77b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5006, "upload_time": "2018-09-21T10:54:05", "upload_time_iso_8601": "2018-09-21T10:54:05.155331Z", "url": "https://files.pythonhosted.org/packages/a8/8f/90a20dd390b51e55baa7c84e87edbff9e2a2de70a8ec43fda834399cbd1e/foliantcontrib.slate-1.0.2-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "fdcb389e6cf2d966bc462c55363d6dab", "sha256": "5e6bb2b454f1abaa971b1d298f6d22261680b7e5db0d421015d61cfdb161fd84" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.2.tar.gz", "has_sig": false, "md5_digest": "fdcb389e6cf2d966bc462c55363d6dab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4962, "upload_time": "2018-09-21T10:54:06", "upload_time_iso_8601": "2018-09-21T10:54:06.731907Z", "url": "https://files.pythonhosted.org/packages/2f/1b/5904ee9fb1e15b02768e5483a41fd6747fc5b768b539f0742776662d1cb5/foliantcontrib.slate-1.0.2.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "cf0fb93fc3f05f6a9a0a2690a43ac68c", "sha256": "1a5316c59eeb17cc595fd96174e92ef3aff1755d125101cd43c077f756758dc0" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "cf0fb93fc3f05f6a9a0a2690a43ac68c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6373, "upload_time": "2018-11-08T11:41:34", "upload_time_iso_8601": "2018-11-08T11:41:34.146741Z", "url": "https://files.pythonhosted.org/packages/6a/fa/53474f9a2a765332a63c39970088c7cd308448bfb76b6fa0893da925536d/foliantcontrib.slate-1.0.3-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "0aab389f02d62e3892ac8eec1f4536c2", "sha256": "47cb3da55c1b82430e7cca6496d560cf66625d2ce6b81b51405310912623a303" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.3.tar.gz", "has_sig": false, "md5_digest": "0aab389f02d62e3892ac8eec1f4536c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5959, "upload_time": "2018-11-08T11:41:35", "upload_time_iso_8601": "2018-11-08T11:41:35.357380Z", "url": "https://files.pythonhosted.org/packages/ac/e0/0572f8c123a5bf8e5be3f92e87c101cdfe985e53f2cd0927180f7843aba8/foliantcontrib.slate-1.0.3.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "6ce85730ddb9ebf1208c7d91953225a2", "sha256": "ae1722249709ad74b02788ff9ecc18c6ffe17a287d7130fa3e83cd99dfb825d3" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "6ce85730ddb9ebf1208c7d91953225a2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6386, "upload_time": "2018-11-16T06:03:01", "upload_time_iso_8601": "2018-11-16T06:03:01.625224Z", "url": "https://files.pythonhosted.org/packages/52/45/b7ff6baf1c0c94596894279576ef6ac6b4a80c45d8eacc1cee2466566831/foliantcontrib.slate-1.0.4-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "65638129f47ed133ce120743e1811aed", "sha256": "37727e2df8c1ac3c6d547ae523e13f36e2cd2c7e1a7d7a0eb27734254d862e87" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.4.tar.gz", "has_sig": false, "md5_digest": "65638129f47ed133ce120743e1811aed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5966, "upload_time": "2018-11-16T06:03:03", "upload_time_iso_8601": "2018-11-16T06:03:03.132209Z", "url": "https://files.pythonhosted.org/packages/08/ec/6686d6d246f502d7b2d542f83addf80c9192e2907671312a66ac3d48fe2a/foliantcontrib.slate-1.0.4.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "6cead7b36e312183645d3a2e5402ab30", "sha256": "316bd110646a9a531582723aa8274bdfd30168babd39e81354830c674cee1494" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "6cead7b36e312183645d3a2e5402ab30", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7306, "upload_time": "2019-10-25T09:12:20", "upload_time_iso_8601": "2019-10-25T09:12:20.620076Z", "url": "https://files.pythonhosted.org/packages/ac/14/415c3f7cd4ab775e26027091e2349b1880f0fa7068dec448a4cb6a101af2/foliantcontrib.slate-1.0.5-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "88318570787fec1d30e4e59ac7cbca69", "sha256": "24c49fe6995e32b6fe00028a79d913d084d0534734ca07741e6d1c9f3a96b0fb" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.5.tar.gz", "has_sig": false, "md5_digest": "88318570787fec1d30e4e59ac7cbca69", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6048, "upload_time": "2019-10-25T09:12:22", "upload_time_iso_8601": "2019-10-25T09:12:22.280018Z", "url": "https://files.pythonhosted.org/packages/3c/2f/ce4442825fc68e84f78d2b3ee04f51b9cc6580c53f64aee4759c79790526/foliantcontrib.slate-1.0.5.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.6": [ { "comment_text": "", "digests": { "md5": "9e6e020458660f06469b07886e6b1f51", "sha256": "6e8349eb647fdc5f00d3221bc13a8730ba628879ad20fa3e430b516f459a05e1" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "9e6e020458660f06469b07886e6b1f51", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7369, "upload_time": "2019-10-25T11:18:10", "upload_time_iso_8601": "2019-10-25T11:18:10.571182Z", "url": "https://files.pythonhosted.org/packages/a9/87/88c823d6272a712102b13a78bf255595ac3ba3410ab4c4f54541c804426f/foliantcontrib.slate-1.0.6-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "fa0f2e7b1407d37f04e3598d7fa7ffbd", "sha256": "7d6ab6837b67e931798a1b04c195623c8f4cc0b90bf40953ea680cce861f5b74" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.6.tar.gz", "has_sig": false, "md5_digest": "fa0f2e7b1407d37f04e3598d7fa7ffbd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6097, "upload_time": "2019-10-25T11:18:12", "upload_time_iso_8601": "2019-10-25T11:18:12.016484Z", "url": "https://files.pythonhosted.org/packages/9c/3f/8a01b7082df025f6e7fb53111025616caeed89096d6bb322feb5ed85b63e/foliantcontrib.slate-1.0.6.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.7": [ { "comment_text": "", "digests": { "md5": "dd25b9323c653adb8c5f4e16ca54c76d", "sha256": "e355d697e7778be2f1d37b59d295eebcf51c6af99a10efd47396e6eb7bc7a89d" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "dd25b9323c653adb8c5f4e16ca54c76d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6669, "upload_time": "2019-12-04T12:42:36", "upload_time_iso_8601": "2019-12-04T12:42:36.984381Z", "url": "https://files.pythonhosted.org/packages/f1/c7/63700869fa70d5bed2fa60fa3df92a27730dcbea9e4600ea14759e6237f0/foliantcontrib.slate-1.0.7-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "a3473ea1b6d6a24004351e1d386654ac", "sha256": "20c743a13811e241ae08e43675b7095bb58acbc9f5baba2dc69c42364272618e" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.7.tar.gz", "has_sig": false, "md5_digest": "a3473ea1b6d6a24004351e1d386654ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5778, "upload_time": "2019-12-04T12:42:38", "upload_time_iso_8601": "2019-12-04T12:42:38.923767Z", "url": "https://files.pythonhosted.org/packages/89/c1/66bdba4d19c64bcff7f32276084ddb56cee3957ebe51fc127caa949f2e0f/foliantcontrib.slate-1.0.7.tar.gz", "yanked": false, "yanked_reason": null } ], "1.0.8": [ { "comment_text": "", "digests": { "md5": "88282297b3738cb2e51f49fe5c4460bb", "sha256": "98de101851216e3912ce844834f2100e4d8a852cf78e93bedc1499214ce28797" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "88282297b3738cb2e51f49fe5c4460bb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6648, "upload_time": "2020-02-04T07:43:44", "upload_time_iso_8601": "2020-02-04T07:43:44.784243Z", "url": "https://files.pythonhosted.org/packages/37/56/c7f6bb00756d16502992122e6264bfe4fd43f21ce0627bb1da1d082e0edc/foliantcontrib.slate-1.0.8-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "e1c7c6a35bbbf4d1a67b6091d2d453ed", "sha256": "6e87c340be52ac6af3d323425376fa6276e0ec5ac41fa4b42160a91fe9afd5e3" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.8.tar.gz", "has_sig": false, "md5_digest": "e1c7c6a35bbbf4d1a67b6091d2d453ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5738, "upload_time": "2020-02-04T07:43:46", "upload_time_iso_8601": "2020-02-04T07:43:46.362981Z", "url": "https://files.pythonhosted.org/packages/f4/91/b444cc2c98541909c2d4195a7290547a7ee93288307a3db33acf32a3b990/foliantcontrib.slate-1.0.8.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "88282297b3738cb2e51f49fe5c4460bb", "sha256": "98de101851216e3912ce844834f2100e4d8a852cf78e93bedc1499214ce28797" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "88282297b3738cb2e51f49fe5c4460bb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6648, "upload_time": "2020-02-04T07:43:44", "upload_time_iso_8601": "2020-02-04T07:43:44.784243Z", "url": "https://files.pythonhosted.org/packages/37/56/c7f6bb00756d16502992122e6264bfe4fd43f21ce0627bb1da1d082e0edc/foliantcontrib.slate-1.0.8-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "e1c7c6a35bbbf4d1a67b6091d2d453ed", "sha256": "6e87c340be52ac6af3d323425376fa6276e0ec5ac41fa4b42160a91fe9afd5e3" }, "downloads": -1, "filename": "foliantcontrib.slate-1.0.8.tar.gz", "has_sig": false, "md5_digest": "e1c7c6a35bbbf4d1a67b6091d2d453ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5738, "upload_time": "2020-02-04T07:43:46", "upload_time_iso_8601": "2020-02-04T07:43:46.362981Z", "url": "https://files.pythonhosted.org/packages/f4/91/b444cc2c98541909c2d4195a7290547a7ee93288307a3db33acf32a3b990/foliantcontrib.slate-1.0.8.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }