{"id":25528821,"url":"https://github.com/bugbaredrums/docs-as-code","last_synced_at":"2026-01-12T22:30:19.563Z","repository":{"id":274813155,"uuid":"924109345","full_name":"BugBareDrums/docs-as-code","owner":"BugBareDrums","description":"A template to scaffold a technical documentation repository. Uses various open source libraries to generate and publish docs.","archived":false,"fork":false,"pushed_at":"2025-01-29T14:13:59.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T15:24:56.321Z","etag":null,"topics":["confluence","documentation","markdown","marp","mermaid","plant-uml"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BugBareDrums.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-01-29T12:40:07.000Z","updated_at":"2025-01-29T14:18:24.000Z","dependencies_parsed_at":"2025-01-29T15:35:10.842Z","dependency_job_id":null,"html_url":"https://github.com/BugBareDrums/docs-as-code","commit_stats":null,"previous_names":["bugbaredrums/docs-as-code"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugBareDrums%2Fdocs-as-code","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugBareDrums%2Fdocs-as-code/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugBareDrums%2Fdocs-as-code/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugBareDrums%2Fdocs-as-code/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BugBareDrums","download_url":"https://codeload.github.com/BugBareDrums/docs-as-code/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239749379,"owners_count":19690433,"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":["confluence","documentation","markdown","marp","mermaid","plant-uml"],"created_at":"2025-02-19T23:23:24.150Z","updated_at":"2026-01-12T22:30:19.501Z","avatar_url":"https://github.com/BugBareDrums.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docs as code\n\nThis template repo can be used to author your technical documentation and slide decks in markdown, mermaid and/or PlantUML. Using the npm scripts you can generate diagrams as svg/png etc, output slide decks in html/pptx and push everything to confluence.\n\nThe repo uses and is entirely dependent on:\n\n- [Mermaid](https://mermaid.js.org/)\n- [PlantUML](https://plantuml.com/)\n- [Marp](https://marp.app/)\n- [Markdown Confluence](https://github.com/markdown-confluence/markdown-confluence)\n\n## Generate diagrams\n\nTo generate the PlantUML diagrams via docker, run:\n\n```bash\nnpm run start\nnpm run generate\n```\n\nif using podman run:\n\n```bash\nnpm run start-pod\nnpm run generate\n```\n\nThis will start a container that is able to render the puml files into svg pictures.\n\n\u003e note: the puml files must all be under the `./docs` folder.\n\nIf you would like a live puml preview and use vscode, try the extension `jebbs.plantuml` with the following settings:\n\n```json\n  \"plantuml.server\": \"http://localhost:8088\",\n  \"plantuml.render\": \"PlantUMLServer\",\n  \"plantuml.exportOutDir\": \"docs\",\n  \"plantuml.exportFormat\": \"svg\",\n  \"plantuml.diagramsRoot\": \"docs\",\n  \"plantuml.exportSubFolder\": false,\n  \"plantuml.exportIncludeFolderHeirarchy\": true,\n```\n\n## Diagrams\n\nDiagrams can be written in [mermaid](https://mermaid.js.org/), [PlantUML](https://plantuml.com/) or [GraphViz](https://graphviz.org/).\n\nMermaid is the simplest and can be added directly to markdown files like so:\n\n```mermaid\nflowchart TD\n    write(Write mermaid) --\u003e happy(Be happy)\n```\n\nPlantUML offers more diagram types and better rendering of C4 architecture diagrams. To create these,\nadd a `.puml` file anywhere under the `./docs` folder and follow the instructions above to generate.\nFor a better authoring experience, install the [PlantUML VSCode extension](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) and [syntax extension](https://marketplace.visualstudio.com/items?itemName=qhoekman.language-plantuml).\n\nThe vscode workspace settings to render live previews with the local PlantUML server (npm run start) are included in this repo.\n\n## Slide decks\n\nIf you need to produce slide decks, you can\nproduce these using markdown with the excellent [marp](https://marp.app/). Again, there is a [VSCode extension](https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode) to provide live previews.\n\nTo create a powerpoint deck for your markdown slide deck, add an npm script for your file, similar\nto `generate:intro`.\n\n## Publish to confluence\n\nThe contents of the `docs` folder can be pushed to confluence by running `npm run publish`.\n\nThey will be published under this parent page: https://eaflood.atlassian.net/wiki/spaces/FFG/pages/5411209331/Future+Farming+Grants+Technical+Documentation\n\nYou will need to specify a username and API key in a .env file. To do so, create an API token\n[here](https://id.atlassian.com/manage-profile/security/api-tokens) then copy the .env.example file to a file called .env then fill out your atlassian username and API token.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugbaredrums%2Fdocs-as-code","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbugbaredrums%2Fdocs-as-code","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugbaredrums%2Fdocs-as-code/lists"}