{"id":21589984,"url":"https://github.com/toolbuddy/docogen","last_synced_at":"2025-04-10T22:16:49.925Z","repository":{"id":57214125,"uuid":"105256240","full_name":"toolbuddy/docoGen","owner":"toolbuddy","description":"A document tool within your masterpiece.","archived":false,"fork":false,"pushed_at":"2018-03-25T03:09:59.000Z","size":1610,"stargazers_count":33,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T19:13:26.211Z","etag":null,"topics":["documentation-generator","json","latex-pdf","markdown","miktex","pdf","standalone"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/docogen","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toolbuddy.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":"2017-09-29T09:40:31.000Z","updated_at":"2019-09-13T17:18:09.000Z","dependencies_parsed_at":"2022-08-26T13:41:17.848Z","dependency_job_id":null,"html_url":"https://github.com/toolbuddy/docoGen","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/toolbuddy%2FdocoGen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolbuddy%2FdocoGen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolbuddy%2FdocoGen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolbuddy%2FdocoGen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toolbuddy","download_url":"https://codeload.github.com/toolbuddy/docoGen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248189572,"owners_count":21062264,"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-generator","json","latex-pdf","markdown","miktex","pdf","standalone"],"created_at":"2024-11-24T16:16:31.008Z","updated_at":"2025-04-10T22:16:49.891Z","avatar_url":"https://github.com/toolbuddy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docoGen\n[![npm version](https://badge.fury.io/js/docogen.svg)](https://badge.fury.io/js/docogen)\n[![npm downloads](https://img.shields.io/npm/dm/docogen.svg)](https://img.shields.io/npm/dm/docogen.svg)\n[![](https://data.jsdelivr.com/v1/package/npm/docogen/badge)](https://www.jsdelivr.com/package/npm/docogen)\n\nA document generation tool within your masterpiece.\n\n![docoGen](https://i.imgur.com/ZN1WU8s.png)\n\n* The coverage :\n   - [x] Convert to Latex pdf (latest support, work in progress)\n   - [x] Convert to Markdown pdf (deprecate currently)\n   - [x] Convert to html (latest support, work in progress)\n      - please import package: [`docoGen-webui`](https://github.com/toolbuddy/docoGen-WebUI.git)\n      - currently need to clone the source code to use\n\n# [See More in Wiki](https://github.com/toolbuddy/docogen/wiki)\n* Contain the latest support and usage explanation.\n\n# Prerequisite\n* Dependencies of `node-latex-pdf`. (need to install `MiKTeX` to generate LaTeX document)\n  * You can use `install_dep.sh` or `install_dep.bat` to install dependencies\n* Using the file extension which named `.docogen`, and just store json format in it.\n  * these files treated as configuration dependency to your generated result.\n  * More information (Still working on it, see `test/script/` to see current support)\n* **New feature**: support `markdown` format!\n  * After version `0.1.0`, you can now edit `.md` to writing docoGen!\n  * System will transform markdown to docoGen format.\n  * See the example in `test/md_script/example.md`\n  * More detail information will be append on docoGen wiki.\n* Within docogen running, `MikTex` will asked you to install multiple required package with docogen.\n  * It will **takes minutes** to complete the packages dependency installation.\n  * For `Window` user, if you install MikTeX with option `each install will be notified`, then the first setup will pop out several windows to ask for permission. This is the docoGen format dependencies, It's safety to let it installed.\n\n# Usage\n## For Developer\n* Git clone with submodule\n  * It will clone the example scripts\n```bash\ngit clone --recursive https://github.com/toolbuddy/docoGen.git\n```\n## For User\n* Install\n```bash\nnpm install docogen --save\n```\n\n* Install dependencies (after install docoGen package)\n   * The install scripts are under docoGen package.\n   * Window user\n   ```\n   $ ./node_modules/docogen/install_dep.bat\n   ```\n   * Linux User\n   ```\n   $ bash ./node_modules/docogen/install_dep.sh\n   ```\n\n* Example: Generate LaTeX pdf from docoGen script\n  * `src_path`: the source path to your project root, and it will get all docogen files.\n  * `dest_path`: the destination directory to store those generated pdf.\n  * `options`: the user-defined go here. (JSON object format)\n    * `output`: specify the output pdf filename.\n```js\nconst docogen = require('docogen');\n\n// convert docogen to latex (pdf format), with absolute path\ndocogen.generate_latexpdf( src_path , dest_path , options ,(err,msg)=\u003e{\n    console.log(msg);\n});\n```\n\n* See all current support method in `test/`! Enjoy!\n\n### Some practical usage\n\n* Example - [project usage](https://github.com/kevinbird61/simulation-video-encoder/tree/master/doc)\n   * using `doc.js` as entry to take advantage of `docoGen`\n   * then generate the pdf from scripts under `script/`.\n\n# Join us\n[![Slack Status](https://img.shields.io/badge/slack-active-pink.svg)](https://docogen-team.slack.com)\n\n\n# Author\n* [Kevin Cyu](https://kevinbird61.github.io/Intro/), kevinbird61@gmail.com\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolbuddy%2Fdocogen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoolbuddy%2Fdocogen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolbuddy%2Fdocogen/lists"}