{"id":13781349,"url":"https://github.com/Plate-Project/plate","last_synced_at":"2025-05-11T14:35:00.262Z","repository":{"id":22739513,"uuid":"26084594","full_name":"Plate-Project/plate","owner":"Plate-Project","description":"API Documentations Tool based on Markdown(md)","archived":false,"fork":false,"pushed_at":"2016-08-23T02:29:09.000Z","size":5130,"stargazers_count":42,"open_issues_count":13,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-17T16:42:39.576Z","etag":null,"topics":["api","documentation","markdown","python"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Plate-Project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-02T15:37:23.000Z","updated_at":"2024-01-04T15:45:57.000Z","dependencies_parsed_at":"2022-08-21T10:30:48.806Z","dependency_job_id":null,"html_url":"https://github.com/Plate-Project/plate","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/Plate-Project%2Fplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Plate-Project%2Fplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Plate-Project%2Fplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Plate-Project%2Fplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Plate-Project","download_url":"https://codeload.github.com/Plate-Project/plate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253580376,"owners_count":21930932,"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":["api","documentation","markdown","python"],"created_at":"2024-08-03T18:01:25.140Z","updated_at":"2025-05-11T14:34:59.691Z","avatar_url":"https://github.com/Plate-Project.png","language":"JavaScript","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"Plate\n========\n\n[![Pyhton2.7](https://img.shields.io/badge/python-2.7-brightgreen.svg)](https://github.com/Plate-Project/plate)  [![Pyhton3.4](https://img.shields.io/badge/python-3.4-red.svg)](https://github.com/Plate-Project/plate.git)\n[![Codacy Badge](https://api.codacy.com/project/badge/grade/b6ab9d0d52ee42a8b2bca2c3ce5bea28)](https://www.codacy.com/app/sh84ahn/plate)\n[![Build Status](https://travis-ci.org/Plate-Project/plate.svg?branch=master)](https://travis-ci.org/Plate-Project/plate)\n[![Code Climate](https://codeclimate.com/github/Plate-Project/plate/badges/gpa.svg)](https://codeclimate.com/github/Plate-Project/plate)\n\n\n\nPlate is API Documentations Tool based on Markdown(md). Convert [Slate](http://tripit.github.io/slate) based on Ruby-Middleman to Python-Flask based. And add some different functions for usages.\n\n![plate](https://farm6.staticflickr.com/5820/21503977290_41beb38dcd_b.jpg)\n\nExample site is [plate-project.github.io](http://plate-project.github.io/). Plate document is [plate.readthedocs.org](http://plate.readthedocs.org/en/latest/index.html).\n\n\nFeatures\n------------\n\n- **Configuration File(config.json)**\n: Set a title, programming languages for example codes using `config.json` based on JSON Format. Also set the path of the API documents and TOC(Table of contents). Anyone can easily set up.\n\n- **Support Multi-API documents**\n: [plate](https://github.com/Plate-Project/plate) support multiple API documents(multi markdown format files) for efficient management and amount of documents. As you with,\nuse one markdown file or separate markdown files by API or another criterion. Also you can set the output order using TOC(index.json).\n\n- **Support dynamic changes of documents**\n: You can update the changes of API documents without restarting server. When web page refresh, if exist any changes, [plate](https://github.com/Plate-Project/plate) reload API documents. Users only focus on writing API documents.\n\n\n- **Make Static HTML**\n:\nConvert Markdown(md) to Static HTML using [jinja2 template](http://jinja.pocoo.org/). Use this on github.io and static html service or offline.\n\n- **Multi-Languages Searching**\n: To [support searching various languages](http://plate.readthedocs.org/en/latest/advanced.html#multi-language-search) such as Japanese, French, German, etc, use not only [lunr.js](http://lunrjs.com/) but also [lunr-languages](https://github.com/MihaiValentin/lunr-languages).\n\n- **Code Copy**\n: It can be easily copy the example codes without mouse drag and drop, immediately apply this to your codes. Set \u003ccode\u003eCLIPBOARD\u003c/code\u003e in `config.json`, can copy codes using clicking copy link.\n\n\nPlate is very easy for any developers. First of all, follow below **Getting Start**. And then you have any problems, immediately notify(email, issue board, anything). Always, plate is ready for you.\n\n\nGetting Start\n------------------------------\n\n### Support Python Version\n  - **Python, version 2.7 ~ 3.4**\n\n### Prerequisites\n\n - **requirements.txt** have all libraries for running plate\n - If you install using `quick-start.py`, automatically install all libraries.\n\n### Quick Start with Server\n\n 1. Clone plate to your hard drive with `git clone https://github.com/Plate-Project/plate.git`\n 2. `cd plate`\n 3. Install your API document web pages using `quick-start.py`.\n 4. Start with server: `python plate.py`\n\n    ```shell\n    \u003e git clone https://github.com/Plate-Project/plate.git\n    \u003e cd plate\n    \u003e python install.py\n    ...\n    Welcome plate v0.2.6\n    Start your API Document system.\n\n    Typing API document name :\u003cTyping your project\u003e\n    what is API document name? is \"\u003cyour project\u003e\"\n\n    Rename plate to  \"\u003cyour project\u003e\" ...\n    Complete. Enjoy developing.\n\n    \u003e cd ../\u003cyour project\u003e\n    \u003e python plate.py\n    ```\n\n### Quick Start with Static HTML\nStart with static html: `python pst.py -f \u003cconf file\u003e`\n\n    \u003e python pst.py -f config.json\n\n### config.json(configuration file)\n- path : ./config.json\n```json\n{\n    \"PORT\"               : 8888,\n    \"TITLE\"              : \"API Document\",\n    \"LOGO_TITLE\"         : \"API Document\",\n    \"SEARCH_ON\"          : true,\n    \"SUPPORT_LANG\"       : [\"shell\", \"python\"],\n    \"API_DOC_PATH\"       : \"./document\",\n    \"API_DOC_INDEX_PATH\" : \"index.json\",\n    \"COPYRIGHT\"          : \"© 2016 plate\",\n    \"FAVICON\"            : \"favicon.ico\",\n    \"CLIPBOARD\"          : true,\n    \"STATIC\" : {\n        \"DIR\" : \"./plate_static\",\n        \"HTML\" : \"index.html\"\n    }\n}\n```\n\n### index.json(Table of contents)\n- path : ./document/index.json\n```json\n{\n    \"ORDER\":\n    [\n        \"Introduction.md\",\n        \"Signup.md\",\n        \"Signin.md\"\n    ]\n}\n```\n\nVersion v0.2.6\n--------------\n- V0.2.6\n    - Add Test Cases.\n- V0.2.5\n    - Change basic structures\n    - Add Unit Testing\n- v0.2.4\n    - Apply Sphinx documentation\n\n\nMore Info\n--------------------\nMore Information such as example, usage, internal, advanced is here. [plate.readthedocs.org](http://plate.readthedocs.org/en/latest/index.html)\n\n\n\nContributing\n--------------------\nAny suggestions [submit a issue](https://github.com/Plate-Project/plate/issues).\nShow me the pull requests.\n\n\nSpecial Thanks\n-----------------\n- [slate](https://github.com/tripit/slate)\n- [pygments](http://pygments.org/)\n- [lunr-languages](https://github.com/MihaiValentin/lunr-languages)\n\nLicense\n------------\n\nCopyright 2016 Plate\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPlate-Project%2Fplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPlate-Project%2Fplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPlate-Project%2Fplate/lists"}