{"id":13452213,"url":"https://github.com/appbaseio/Docbase","last_synced_at":"2025-03-23T19:33:50.414Z","repository":{"id":27081168,"uuid":"30547843","full_name":"appbaseio/Docbase","owner":"appbaseio","description":"Turn .md docs into beautiful sites","archived":true,"fork":false,"pushed_at":"2018-02-01T06:03:47.000Z","size":7613,"stargazers_count":587,"open_issues_count":11,"forks_count":24,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-03-19T21:55:19.595Z","etag":null,"topics":["appbaseio","docbase","documentation-hub","documentation-tool","javascript","markdown"],"latest_commit_sha":null,"homepage":"https://appbaseio.github.io/Docbase","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appbaseio.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":"2015-02-09T17:16:35.000Z","updated_at":"2025-03-08T16:02:15.000Z","dependencies_parsed_at":"2022-08-31T00:01:28.480Z","dependency_job_id":null,"html_url":"https://github.com/appbaseio/Docbase","commit_stats":null,"previous_names":[],"tags_count":79,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2FDocbase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2FDocbase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2FDocbase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2FDocbase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appbaseio","download_url":"https://codeload.github.com/appbaseio/Docbase/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245159150,"owners_count":20570331,"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":["appbaseio","docbase","documentation-hub","documentation-tool","javascript","markdown"],"created_at":"2024-07-31T07:01:17.103Z","updated_at":"2025-03-23T19:33:50.017Z","avatar_url":"https://github.com/appbaseio.png","language":"JavaScript","readme":"# Docbase\n[![Build Status](https://travis-ci.org/appbaseio/Docbase.svg?branch=master)](https://travis-ci.org/appbaseio/Docbase) [![NPM](https://nodei.co/npm/grunt-docbase.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/grunt-docbase/)\n\n### We are no longer actively maintaining Docbase, we instead recommend using [gatsbyjs](https://gatsbyjs.org).\n\nTurn .md files into a beautiful documentation hub with versioning and beautifully rendered menus. \n\n* Docbase can read files that are hosted on github, locally or a http:// server.\n* It can publish documentation hubs to github pages (via travis) or locally which can be served with as static files with a http:// server.\n\nDocbase comes with a yeoman generator that turns the installation and configuration process into a piece of cake.\n\n![A rendered documentation site](http://g.recordit.co/Odu27H3nAm.gif)\n\n### Example Hubs built with Docbase\n\n1. [Airbnb JS Style guide](https://farhan687.github.io/airbnb)  \n2. [Redis Docs](https://farhan687.github.io/redis)  \n3. [EmberJS Guide](https://farhan687.github.io/emberjs)\n\n## Installation\n\n```\n1. npm install -g yo\n\n█████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒\n\n2. npm install -g generator-docbase\n\n██████████▒▒▒▒▒▒▒▒▒▒\n\n3. yo docbase\n\nWelcome to\n    .___           ___.\n  __| _/____   ____\\_ |__ _____    ______ ____\n / __ |/  _ \\_/ ___\\| __ \\\\__  \\  /  ___// __ \\\n/ /_/ (  \u003c_\u003e )  \\___| \\_\\ \\/ __ \\_\\___ \\\\  ___/\n\\____ |\\____/ \\___  \u003e___  (____  /____  \u003e\\___  \u003e\n     \\/           \\/    \\/     \\/     \\/     \\/\n        generator!\n\n...\n\n████████████████████\n\nDocbase is live at: http://127.0.0.1:1234\n```\n\n##  [Read the manual](https://appbaseio.github.io/docbase-manual) [![](http://businessxlerator.com/wp-content/themes/busxl-2015/images/content/icons/book.png)](https://appbaseio.github.io/docbase-manual)\n\nThe manual walks through the generator options, and explains docbase options and features. The manual itself is served with docbase.\n\n\n### Who uses docbase\n\n- [appbase.io](https://docs.appbase.io)\n- [Reactive Maps](https://opensource.appbase.io/reactivemaps/manual)\n\nSend a PR with your name here.\n\n\n## History\n\nv0.3.0 Feb 27 '17\n- Phantom.js dependency upgrade\n- Compatibility with Node v6.9.x\n- Uses scroll in code blocks\n- Fixes mobile read view\n- Adds a feature to see other pages in the directory\n\nv0.2.56 Apr 2 '16\n- Comes with a yeoman generator ``yo docbase``\n- Resizable mobile navigation menu\n- Realtime search with an offline search index\n- No 404s when navigating to folders\n- Updates markdown parser\n- Show github contributors on each documentation page\n- Colorful themes baked in\n\n.  \n.  (54 more releases)  \n.  \n\nv0.0.2 Aug 7 '15\n- All flatdoc theme options supported\n- Customizable root path\n\nv0.0.1 Feb 10 '15  \n- Initial release\n\n## Credits\n\nHenrique Sa (@henriquesa),  \nMateus Freira (@mateusfreira),  \nFarhan Chauhan (@farhan687),  \nSiddharth Kothari (@siddharthlatest)  \n\n## License\n\nMIT\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2FDocbase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappbaseio%2FDocbase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2FDocbase/lists"}