{"id":21683773,"url":"https://github.com/open-eo/openeo-processes-docgen","last_synced_at":"2025-03-20T11:23:50.315Z","repository":{"id":46236000,"uuid":"140853619","full_name":"Open-EO/openeo-processes-docgen","owner":"Open-EO","description":"Library to generate a user interface for documents following the specification for openEO processes.","archived":false,"fork":false,"pushed_at":"2022-08-29T16:46:14.000Z","size":8376,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-25T05:22:24.656Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://open-eo.github.io/openeo-processes-docgen/demo/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Open-EO.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-07-13T14:00:11.000Z","updated_at":"2024-07-26T18:20:28.669Z","dependencies_parsed_at":"2022-09-13T08:22:09.299Z","dependency_job_id":null,"html_url":"https://github.com/Open-EO/openeo-processes-docgen","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-processes-docgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-processes-docgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-processes-docgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Open-EO%2Fopeneo-processes-docgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Open-EO","download_url":"https://codeload.github.com/Open-EO/openeo-processes-docgen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244601955,"owners_count":20479530,"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-25T16:13:27.864Z","updated_at":"2025-03-20T11:23:50.293Z","avatar_url":"https://github.com/Open-EO.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openEO Processes DocGen\nLibrary to generate a human-readable version of documents following the [specification for openEO processes](https://github.com/open-eo/openeo-api), either in version 0.4.x or 1.x.x.\n\n* [Demo](https://open-eo.github.io/openeo-processes-docgen/demo/).\n\n## Getting Started\n\nYou can simply create an HTML file and change the `document` and `apiVersion` (see below) prop to your needs:\n```\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n\n\t\u003chead\u003e\n\t\t\u003ctitle\u003eopenEO Processes\u003c/title\u003e\n\t\t\u003cmeta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"\u003e\n\t\t\u003cmeta charset=\"UTF-8\"\u003e\n\t\t\u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\"\u003e\n\t\t\u003cscript src=\"https://cdn.jsdelivr.net/npm/vue\"\u003e\u003c/script\u003e\n\t\t\u003cscript src=\"https://cdn.jsdelivr.net/npm/@openeo/processes-docgen@1/dist/DocGen.umd.min.js\"\u003e\u003c/script\u003e\n\t\t\u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/@openeo/processes-docgen@1/dist/DocGen.css\"\u003e\n\t\t\u003cstyle\u003ehtml, body { height: 100%; margin: 0; }\u003c/style\u003e\n\t\u003c/head\u003e\n\n\t\u003cbody\u003e\n\t\t\u003cdiv id=\"app\"\u003e\u003c/div\u003e\n\t\t\u003cscript\u003e\n\t\tnew Vue({\n\t\t\tel: '#app',\n\t\t\trender: h =\u003e h(DocGen, { \n\t\t\t\tprops: {\n\t\t\t\t\t// Either (1) a URL to the document as string\n\t\t\t\t\t// or (2) an array or object containing the processes.\n\t\t\t\t\tdocument: 'processes.json',\n\t\t\t\t\t// The version of the openEO API\n\t\t\t\t\tapiVersion: \"1.2.0\",\n\t\t\t\t\t// Title for the table of contents\n\t\t\t\t\t// title: \"My processes\",\n\t\t\t\t\t// Sorts the processes by id if set to true, otherwise keeps order of the document\n\t\t\t\t\t// sortProcessesById: true,\n\t\t\t\t\t// Categorize the processes in the menu if set to true, otherwise show a plain list\n\t\t\t\t\t// categorize: true,\n\t\t\t\t\t// Show/Hide table of contents, links and search box\n\t\t\t\t\t// showTableOfContents: true,\n\t\t\t\t\t// A message that is shown to users\n\t\t\t\t\t// notice: ''\n\t\t\t\t\t// Show or hide experimental and/or deprecated entites by default (e.g. processes, collections)\n\t\t\t\t\t// showExperimentalByDefault: false,\n\t\t\t\t\t// showDeprecatedByDefault: false,\n\t\t\t\t}\n\t\t\t})\n\t\t});\n\t\t\u003c/script\u003e\n\t\t\u003cnoscript\u003eSorry, the documentation generator requires JavaScript to be enabled!\u003c/noscript\u003e\n\t\u003c/body\u003e\n\n\u003c/html\u003e\n```\n\n## Development\n\nTo build the files follow these steps:\n\n1. Install [Node.js](https://nodejs.org/)\n2. Clone or download this repository.\n3. Open a command line window and go to the directory which contains the cloned/downloaded web editor files.\n4. Optionally: Configure the generator by editing `vue.config.js` and `src/config.js` to suit your needs.\n5. Install the dependencies by executing `npm install` on the command line\n6. \n\t* Development: Run the development server by executing `npm start`.\n\t* Deployment:\n\t\t* Standalone: Build the project by executing `npm run build_standalone`. Afterwards upload the content of the `dist` folder to your server.\n\t\t* Library: Build the project by executing `npm run build`. Afterwards you can publish the library to npm or so.\n\n## License\n\nThis project is licensed under the Apache 2.0 license - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-eo%2Fopeneo-processes-docgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-eo%2Fopeneo-processes-docgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-eo%2Fopeneo-processes-docgen/lists"}