{"id":13802728,"url":"https://github.com/mpociot/whiteboard","last_synced_at":"2025-05-16T14:04:39.830Z","repository":{"id":41281091,"uuid":"50463252","full_name":"mpociot/whiteboard","owner":"mpociot","description":"Simply write beautiful API documentation.","archived":false,"fork":false,"pushed_at":"2021-01-29T11:20:13.000Z","size":294,"stargazers_count":1228,"open_issues_count":15,"forks_count":124,"subscribers_count":29,"default_branch":"master","last_synced_at":"2025-05-15T16:58:43.846Z","etag":null,"topics":[],"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/mpociot.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":"2016-01-26T22:15:34.000Z","updated_at":"2025-03-05T03:25:00.000Z","dependencies_parsed_at":"2022-07-14T11:30:48.012Z","dependency_job_id":null,"html_url":"https://github.com/mpociot/whiteboard","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/mpociot%2Fwhiteboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpociot%2Fwhiteboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpociot%2Fwhiteboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mpociot%2Fwhiteboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mpociot","download_url":"https://codeload.github.com/mpociot/whiteboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"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-08-04T00:01:52.117Z","updated_at":"2025-05-16T14:04:39.807Z","avatar_url":"https://github.com/mpociot.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Documentation"],"sub_categories":["Free"],"readme":"# Whiteboard\n#### Simply write beautiful API documentation.\n\nThis project started as a fork of the popular [Slate](https://github.com/tripit/slate) API documentation tool, which uses ruby. Since I found the initial setup of Slate quite cumbersome, I started this NodeJS based project.\n\n\u003ca href=\"https://pociot.dev/whiteboard/\"\u003e\u003cimg src=\"https://pociot.dev/git/whiteboard_responsive.jpg\" style=\"width: 100%\" alt=\"Whiteboard\" /\u003e\u003c/a\u003e\n\nCheck out a Whiteboard [example API documentation](https://pociot.dev/whiteboard/).\n\n## Getting Started with Whiteboard\n\n### Prerequisites\n\nYou're going to need:\n\n - **[Node JS](https://nodejs.org/en/)**\n\n_Yes, that's it!_\n\n### Getting Set Up\n\n 1. Clone this repository to your hard drive with `git clone https://github.com/mpociot/whiteboard.git`\n 2. `cd whiteboard`\n 3. Install the dependencies: `npm install`\n 4. Start the test server: `npm start`\n\nNow go ahead and visit \u003chttp://localhost:4000\u003e and you will be presented with a beautiful example API documentation as a starting point.\n\nGo ahead and modify the markdown file at `source/index.md` to suit your needs.\n\n### Publishing your API documentation\n\nThe easiest way to publish your API documentation is using this command within your `whiteboard` directory:\n\n`npm run-script generate`\n\nThis will generate a `public` folder which you can upload anywhere you want.\n\n\u003e **Windows users:** You need to install the global `hexo-cli` package using `npm install -g hexo-cli`. To publish your API documentation under windows use `hexo generate`.\n\nIf you want other (more automated) deployment options like **git**, **heroku**, **rsync** or **ftp** - please take a look at the [Hexo deployment documentation](https://hexo.io/docs/deployment.html).\n\n### Generate the documentation programmatically\n\nTo generate the API documentation programmatically, for example in your automated build process, use the whiteboard module.\nThe `generate` method will return a promise.\n\n```js\nvar Whiteboard = require('whiteboard');\nWhiteboard.generate()\n  .then(function(){\n    // Generation was successful\n  })\n  .catch(function(){\n    // Handle error\n  })\n```\n\n### Slate compatibility\nSince both Whiteboard and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please [submit an issue](https://github.com/mpociot/whiteboard/issues).\n\n### In depth documentation\nFor further documentation, read the [Slate Wiki](https://github.com/tripit/slate/wiki) or the [hexo documentation](https://hexo.io/docs/).\n\n### Documentations built with Whiteboard\n\n* [DISTRIBUTOR API Documentation](https://wifidistribution.com/docs) from [wifidistribution.com](https://wifidistribution.com) \n* [CommoPrices API Documentation](https://api.commoprices.com/docs/) from [commoprices.com](https://commoprices.com/) \n* [TradeIt JSON API](https://www.trade.it/documentation/api) from [trade.it](https://www.trade.it/) \n\nFeel free to submit a PR with a link to your documentation.\n\n### Contributors\n\nSlate was built by [Robert Lord](https://lord.io) while at [TripIt](http://tripit.com).\n\nWhiteboard was built by Marcel Pociot.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpociot%2Fwhiteboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmpociot%2Fwhiteboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmpociot%2Fwhiteboard/lists"}