{"id":23513052,"url":"https://github.com/cef62/documentor","last_synced_at":"2025-10-17T20:45:45.403Z","repository":{"id":149659376,"uuid":"43697838","full_name":"cef62/documentor","owner":"cef62","description":"Make documentation for Web projects","archived":false,"fork":false,"pushed_at":"2015-10-05T21:24:17.000Z","size":4348,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-25T13:26:43.359Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/cef62.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-05T16:23:08.000Z","updated_at":"2015-10-05T16:23:36.000Z","dependencies_parsed_at":"2023-04-09T03:35:23.945Z","dependency_job_id":null,"html_url":"https://github.com/cef62/documentor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cef62%2Fdocumentor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cef62%2Fdocumentor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cef62%2Fdocumentor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cef62%2Fdocumentor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cef62","download_url":"https://codeload.github.com/cef62/documentor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239197164,"owners_count":19598328,"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-12-25T13:26:47.406Z","updated_at":"2025-10-17T20:45:45.322Z","avatar_url":"https://github.com/cef62.png","language":"JavaScript","readme":"# documentor \n[![Travis-CI](https://travis-ci.org/cef62/documentor.svg)](https://travis-ci.org/cef62/documentor)\n\nDocumentor is an automated docs builder based on **[metalsmith](www.metalsmith.io)**. \n\n\u003e The tools is in active development and the current API it's likely to change often. Any feedback is welcome.\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n## Contents\n\n- [Plugins](#plugins)\n  - [metalsmith](#metalsmith)\n  - [ markdown-it](#markdown-it)\n  - [templates](#templates)\n- [Getting Started](#getting-started)\n  - [CLI invocation](#cli-invocation)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Plugins\n\n### metalsmith\n\n**documentor** depends on the following _metalsmith_ plugins:\n\n* metalsmith-assets\n* metalsmith-babel\n* metalsmith-drafts\n* metalsmith-lunr\n* metalsmith-markdownit\n* metalsmith-navigation\n* metalsmith-templates\n* metalsmith-text-replace\n\nInternally documentor use more plugins, soon this plugins will be moved on separated repositories.\n\n### markdown-it\n\n**documentor** depends on the following _markdown-it_ plugins:\n\n* markdown-it-checkbox\n* markdown-it-container\n* markdown-it-emoji\n* markdown-it-footnote\n\nInternally documentor use more plugins and custom renderers, soon this plugins will be moved on separated repositories.\n\n### templates\n\nTemplates are defined using **handlebars** syntax.\n\n## Getting Started\n\n**documentor** can be used as CLI command or via Javascript.\n\n### CLI invocation\n\nInvoked from CLI **documentor** accept and require a single arguments: `--config`. **config** should be the path to a javascript module exporting a configuration object:\n\n```javascript\n// ./docs/index.js\nvar path = require('path');\n\n// compose full path to sources and build folders\nfunction compose() {\n  var params = [].splice.call(arguments,0);\n  params.unshift(__dirname);\n  return slash(path.join.apply(null, params));\n}\n\nmodeule.exports = {\n\tfolders: {\n  \t\tsource: compose('data'),\n  \t\tbuild: compose('build'),\n\t}\n};\n```\n\nAt least `source` and `destination` folder must be defined.\n\nIn you package.json add a script:\n\n```json\n\"script\": {\n\t\"build:doc\": \"documentor --config ./docs/index.js\"\n},\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcef62%2Fdocumentor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcef62%2Fdocumentor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcef62%2Fdocumentor/lists"}