{"id":21253923,"url":"https://github.com/courseorchestra/celestadoc","last_synced_at":"2025-03-15T05:43:52.851Z","repository":{"id":37987034,"uuid":"151135183","full_name":"CourseOrchestra/celestadoc","owner":"CourseOrchestra","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-28T01:03:48.000Z","size":75,"stargazers_count":0,"open_issues_count":9,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-21T21:15:35.029Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","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/CourseOrchestra.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":"2018-10-01T18:09:56.000Z","updated_at":"2023-01-31T17:05:23.000Z","dependencies_parsed_at":"2023-02-19T03:15:46.495Z","dependency_job_id":null,"html_url":"https://github.com/CourseOrchestra/celestadoc","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/CourseOrchestra%2Fcelestadoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CourseOrchestra%2Fcelestadoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CourseOrchestra%2Fcelestadoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CourseOrchestra%2Fcelestadoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CourseOrchestra","download_url":"https://codeload.github.com/CourseOrchestra/celestadoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243690150,"owners_count":20331729,"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-11-21T03:53:29.129Z","updated_at":"2025-03-15T05:43:52.832Z","avatar_url":"https://github.com/CourseOrchestra.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CelestaDoc\n\n[![Actions Status: build](https://github.com/courseorchestra/celestadoc/workflows/build/badge.svg)](https://github.com/courseorchestra/celestadoc/actions?query=workflow%3A\"build\")\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/ru.curs/celestadoc/badge.svg)](https://maven-badges.herokuapp.com/maven-central/ru.curs/celestadoc)\n\n\nGenerates celesta documentation report.\n\nFirst, you should install project:\n\n```shell\nmvn clean install\n```\n\nAfter you can get zip-archive CelestaDoc, inside it you can find celestadoc.bat file.\nRun it with the next command:\n\n```shell\ncelestadoc.bat \u003cpath_to_directory_with_celesta_sql\u003e \u003cprefix\u003e \u003coutput_file.adoc\u003e [optional]-pdf [optional]-html [optional][-plantuml [optional]\u003cparam_file.pu\u003e]\n```\n\nwhere \n\n* `path_to_directory_with_celesta_sql` - directory with celesta sql,\n\n* `prefix` - some prefix which is used in celesta docs (For example, `doc-ru`)\n\n* `output_file.adoc` - path to file which will be created. It should be .adoc file\n\n* `-pdf` - optional flag for generating pdf file from adoc file. This file will be\ncreated in the same directory as .adoc report, and it will had the same name `output_file.pdf`\n\n* `-html` - optional flag for generating html file from adoc file. This file will be created in the same directory\nas .adoc report, and it will had the same name `output_file.html`\n\n* `-plantuml` - optional flag for generating plant UML file from celesta sql file. This file will be created in the same\ndirectory as .adoc report, and it will had the same name `output_file.pu`\n\n* `param_file.pu` - file with params for plant UML's diagram. It must be used only with flag `-plantuml`, and must be\nafter this flag. This param is optional parameter. For example, you can write `-plantuml my_param.pu` or `-plantuml`.\nIn second case in section `!include` will be included default file `pu_params.pu`, that can be found in project's sources.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcourseorchestra%2Fcelestadoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcourseorchestra%2Fcelestadoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcourseorchestra%2Fcelestadoc/lists"}