{"id":20250032,"url":"https://github.com/bafs/documentor","last_synced_at":"2025-04-10T22:45:23.518Z","repository":{"id":42818565,"uuid":"108922835","full_name":"BafS/Documentor","owner":"BafS","description":"Super intuitive documentation generator, from markdown files to a single html file (style, scripts, images, search engine embedded) 📖 ","archived":false,"fork":false,"pushed_at":"2023-03-04T21:15:12.000Z","size":409,"stargazers_count":43,"open_issues_count":16,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T22:45:19.243Z","etag":null,"topics":["documentation","documentation-tool","documentator","markdown","static-site-generator"],"latest_commit_sha":null,"homepage":"https://bafs.github.io/Documentor","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BafS.png","metadata":{"files":{"readme":"Readme.md","changelog":"Changelog.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-31T00:14:43.000Z","updated_at":"2025-01-05T14:02:44.000Z","dependencies_parsed_at":"2023-02-05T15:16:14.676Z","dependency_job_id":null,"html_url":"https://github.com/BafS/Documentor","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/BafS%2FDocumentor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BafS%2FDocumentor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BafS%2FDocumentor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BafS%2FDocumentor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BafS","download_url":"https://codeload.github.com/BafS/Documentor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248312190,"owners_count":21082637,"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":["documentation","documentation-tool","documentator","markdown","static-site-generator"],"created_at":"2024-11-14T09:56:48.668Z","updated_at":"2025-04-10T22:45:23.500Z","avatar_url":"https://github.com/BafS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://bafs.github.io/Documentor\" target=\"_blank\"\u003e\u003cimg width=\"550\"\nsrc=\"https://i.imgur.com/j8Bh0cv.png\"/\u003e\u003c/a\u003e\n\n\u003e A super intuitive doc generator from Markdown files\n\n# Installation\n\n```sh\nnpm -g i documentor\n```\n\nor for yarn users: `yarn global add documentor`\n\n## Quick Usage\n\n```sh\ndocumentor init  # initialisation of the documentation\n```\n\n```sh\ndocumentor ./docs-folder -o output.html  # render the documentation to output.html\n```\n\n![https://i.imgur.com/whek9Zm.png](https://i.imgur.com/whek9Zm.png)\n\n# [Documentation](http://bafs.github.io/Documentor)\n\nPlease check the [**documentation**](http://bafs.github.io/Documentor) for more details.\n\n## Command Line Usage\n\n- **`-i`**, **`--input`**: Input folder (optional flag)\n- **`-o`**, **`--output`**: Write in file\n- **`-t`**, **`--to`**: Output format\n- **`-c`**, **`--config`**: Configuration file\n- **`-w`**, **`--watch`**: Watch docs files with partial generation\n- **`-q`**, **`--quite`**: Do not output any message\n- **`-v`**, **`--verbose`**: Increase the verbosity\n- **`--var`**, **`--variable`**: Set or override config variable(s)\n- **`-h`**, **`--help`**: Show help\n\n### Examples\n\nGenerate `project.html` from `./docs` folder\n\n```sh\ndocumentor ./docs -o out.html\n```\n\nOutput html to STDOUT from `./docs` folder and read the configuration file `conf.yml`\n\n```sh\ndocumentor docs -c conf.yml\n```\n\nGenerate \"out.html\" with a custom name and footer\n\n```sh\ndocumentor ./docs -o out.html --var.name \"My Project\" --var.footer \"(c) Project 1.0\"\n```\n\nWatch the \"docs\" folder and regenerate \"out.html\" on change\n\n```sh\ndocumentor docs -o out.html -w\n```\n\n## Dev\n\n```sh\nnpm i\n```\n\nYou can run the CLI version with `node bin/documentor.js`, for example `node bin/documentor.js ./docs -o out.html`.\n\n### Test\n\n```sh\nnpm test\n```\n\n# Screenshot\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://bafs.github.io/Documentor\" target=\"_blank\"\u003e\u003cimg width=\"600\" src=\"https://i.imgur.com/wErMEKf.png\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\n#### TODO\n\n - [ ] Embed images from markdown\n - [ ] Add processing indicator\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbafs%2Fdocumentor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbafs%2Fdocumentor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbafs%2Fdocumentor/lists"}