{"id":23058831,"url":"https://github.com/senges/tovald","last_synced_at":"2025-04-28T12:25:18.682Z","repository":{"id":266525745,"uuid":"898600059","full_name":"senges/tovald","owner":"senges","description":"Publish Markdown documentation to Confluence","archived":false,"fork":false,"pushed_at":"2024-12-06T15:40:06.000Z","size":278,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-16T02:17:14.963Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/senges.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-04T17:23:59.000Z","updated_at":"2024-12-06T15:40:05.000Z","dependencies_parsed_at":"2024-12-04T18:35:08.551Z","dependency_job_id":"4c94e059-c6cc-4933-aaf3-c1ba4b50a6f2","html_url":"https://github.com/senges/tovald","commit_stats":null,"previous_names":["senges/tovald"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senges%2Ftovald","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senges%2Ftovald/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senges%2Ftovald/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senges%2Ftovald/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/senges","download_url":"https://codeload.github.com/senges/tovald/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237863961,"owners_count":19378261,"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-12-16T02:17:46.522Z","updated_at":"2025-04-28T12:25:18.676Z","avatar_url":"https://github.com/senges.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tovald\n\nPublish rich Markdown documentation to Confluence.\n\n## usage (alpha)\n\nInstall tovald with `pipx install tovald` or run virtualenv `uv run tovald`.\n\nExport the following variables :\n- `CONFLUENCE_SERVER_URL`: confluence instance URL\n- `CONFLUENCE_SPACE_KEY`: target confluence space\n- `CONFLUENCE_PARENT_PAGE` (optional): any parent page in a given space\n- `CONFLUENCE_PAT`: service account personal access token\n- `CONFLUENCE_SOURCES_URL` (optional): sources repository URL\n- `CONFLUENCE_PUBLISH_PREFIX` (optional): add page publication prefix\n\n```\nusage: tovald [-h] [-v] [-c] DOCUMENTATION\n\npositional arguments:\n  DOCUMENTATION\n\noptions:\n  -h, --help     show this help message and exit\n  -v, --version  show program's version number and exit\n  -c, --cleanup\n```\n\n## Documentation structure\n\nIn Confluence, documentation is organized using a hierarchical structure of pages and sub-pages.\n\n* Page 1\n    * Sub-page 1\n    * Sub-page 2\n        * Sub-sub-page 1\n* Page 2\n    * Sub-page 3\n\nSimilarly, in tovald documentation structure, each page is represented as a folder containing an `index.md` file and an optional `.assets` folder.\n* The `index.md` file holds the content of the page, and the first-level `# heading` is used as the page title in the page tree view.\n* The `.assets` folder contains any static asset required by the given index page.\n\n```\ndoc\n├── index.md\n└── operational-guide\n    ├── .assets\n    │   └── demo.png\n    └── index.md\n```\n\n## Editorial guide\n\nStandard markdown is supported, as well as [MyST flavored syntax](https://myst-parser.readthedocs.io/en/latest/index.html).\n\nMost Confluence built-in features are also available via [confluencebuilder](https://sphinxcontrib-confluencebuilder.readthedocs.io)\n(ie. Jira integration, emoticon, mentions, macros, ...).\n\n## Contribution\n\nProject management is achieved with `uv`.\n\n```\n$ uv sync --dev\n```\n\nInstall pre-commit hooks.\n```\n$ uv run pre-commit install [--install-hooks]\n```\n\n## Credits\n\nTovald is just a modest wrapper around various tools:\n- [sphinx-doc/sphinx](https://github.com/sphinx-doc/sphinx)\n- [sphinx-contrib/confluencebuilder](https://github.com/sphinx-contrib/confluencebuilder)\n- [executablebooks/MyST-Parser](https://github.com/executablebooks/MyST-Parser)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenges%2Ftovald","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsenges%2Ftovald","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsenges%2Ftovald/lists"}