{"id":18383154,"url":"https://github.com/fugerit-org/fj-doc-guides","last_synced_at":"2025-04-11T21:36:17.742Z","repository":{"id":184917711,"uuid":"672663482","full_name":"fugerit-org/fj-doc-guides","owner":"fugerit-org","description":"Guides to Venus Fugerit Doc Generation Framework","archived":false,"fork":false,"pushed_at":"2024-09-09T08:32:10.000Z","size":76,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-09T10:18:02.911Z","etag":null,"topics":["documentation","excel-generation","java","json","markdown-generator","pdf-generation","xml","yaml"],"latest_commit_sha":null,"homepage":"https://www.fugerit.org/perm/venus/","language":"Java","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/fugerit-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-30T20:56:29.000Z","updated_at":"2024-09-09T08:32:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"54768a28-ebdb-4fff-af10-2363a60c3b6f","html_url":"https://github.com/fugerit-org/fj-doc-guides","commit_stats":null,"previous_names":["fugerit-org/fj-doc-guides"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Ffj-doc-guides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Ffj-doc-guides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Ffj-doc-guides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Ffj-doc-guides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fugerit-org","download_url":"https://codeload.github.com/fugerit-org/fj-doc-guides/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248484336,"owners_count":21111626,"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","excel-generation","java","json","markdown-generator","pdf-generation","xml","yaml"],"created_at":"2024-11-06T01:10:13.630Z","updated_at":"2025-04-11T21:36:17.712Z","avatar_url":"https://github.com/fugerit-org.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Guides to Venus - Fugerit Document Generation Framework (fj-doc)  \n\n## Deprecation notice start\n\nThis guide has been deprecated and will not be maintained, now you can refer to the new official guide\n(built it in the main [Fugerit Venus Doc repository](https://github.com/fugerit-org/fj-doc)) :\n\n[![HTML - Guide](https://img.shields.io/badge/HTML-Guide-blue?style=for-the-badge)](https://venusdocs.fugerit.org/guide/ \"Go to project HTML documentation\")\n[![PDF - Guide](https://img.shields.io/badge/PDF-Guide-red?style=for-the-badge)](https://venusdocs.fugerit.org/guide/fj-doc-guide.pdf \"Go to project PDF documentation\")\n\nDeprecation reasons : \n\n* Most examples and guides are still working they are more complex than required by new version of Fugerit Venus Doc.\n* The new guide is organized in more coherent way\n* The new guide rely on AsciiDoc for formatting, which is more powerful than MaroDown\n\n## Deprecation notice end\n\n## Archive notice start\n\nAs of 2024-10-25, this repository is archived as a consequence of deprecation\n\n## Archive notice end\n\nThis projects provides simple guides to [Venus - Fugerit Document Generation Framework (fj-doc)](https://github.com/fugerit-org/fj-doc) project.\n\n[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](https://github.com/fugerit-org/fj-doc-guides/blob/main/CHANGELOG.md) \n[![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0) \n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-doc-guides\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-doc-guides)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-doc-guides\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-doc-guides)\n\n![Java runtime version](https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge\u0026logo=openjdk\u0026logoColor=white)\n![Java build version](https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge\u0026logo=openjdk\u0026logoColor=white)\n![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge\u0026logo=Apache%20Maven\u0026logoColor=white)\n\n## Index\n\nA new [Wizard](src/docs/wizard/index.md) section is available, guiding you through some common scenarios.\n\n### General topics\n\n- [Venus Doc Format entry point](src/docs/common/doc_format_summary.md) - a starting point for writing the Venus XML meta model\n- [Venus Doc Format and freemarker](src/docs/common/doc_format_freemarker.md) - consideration on using the XML format with [Apache FreeMarker](https://freemarker.apache.org/)\n- [From XML to JSON or YAML source](src/docs/common/doc_from_xml_to_json_or_yaml.md) - informations for using json or yaml as source instead of XML\n- [Project history](src/docs/common/history.md) - some history of the project and the document format\n\n### Guidelines\n\n- ['Framework basics'](src/docs/guidelines/G001_basics.md) - This document explains the basic of the xml source format\n- ['The source XML document format'](src/docs/guidelines/G002_xml_format.md) - This document explains the basics of the xml source format\n\n### Core functionalities practical guides\n\n- [Venus Guide A001 : Hello World PDF](fj-doc-guides-A001-hello-world-pdf/README.md)\n- [Venus Guide A002 : Full document](fj-doc-guides-A002-full-document/README.md)\n- [Venus Guide A003 : Apache FreeMarker Full document](fj-doc-guides-A003-full-document-freemarker/README.md)\n- [Venus Guide A004 : Apache FreeMarker Hello World](fj-doc-guides-A004-freemarker-hello-world/README.md)\n\n### Extra functionalities practical guides\n\n- [Venus Guide E001 : Hello World PDF JSON Source](fj-doc-guides-E001-hello-world-pdf-json-source/README.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffugerit-org%2Ffj-doc-guides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffugerit-org%2Ffj-doc-guides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffugerit-org%2Ffj-doc-guides/lists"}