{"id":41941288,"url":"https://github.com/vividus-framework/docs.vividus.dev","last_synced_at":"2026-01-25T18:38:22.062Z","repository":{"id":37762920,"uuid":"274199328","full_name":"vividus-framework/docs.vividus.dev","owner":"vividus-framework","description":"VIVIDUS documentation","archived":false,"fork":false,"pushed_at":"2025-12-19T10:42:50.000Z","size":275821,"stargazers_count":7,"open_issues_count":5,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-12-22T03:55:16.930Z","etag":null,"topics":["documentation","hacktoberfest","vividus"],"latest_commit_sha":null,"homepage":"","language":"Handlebars","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/vividus-framework.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-06-22T17:17:55.000Z","updated_at":"2025-11-25T07:42:26.000Z","dependencies_parsed_at":"2024-02-21T10:25:11.065Z","dependency_job_id":"27800b8a-30f5-4061-98f4-cc2743fafb87","html_url":"https://github.com/vividus-framework/docs.vividus.dev","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vividus-framework/docs.vividus.dev","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vividus-framework%2Fdocs.vividus.dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vividus-framework%2Fdocs.vividus.dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vividus-framework%2Fdocs.vividus.dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vividus-framework%2Fdocs.vividus.dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vividus-framework","download_url":"https://codeload.github.com/vividus-framework/docs.vividus.dev/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vividus-framework%2Fdocs.vividus.dev/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28756442,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T16:32:25.380Z","status":"ssl_error","status_checked_at":"2026-01-25T16:32:09.189Z","response_time":113,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","hacktoberfest","vividus"],"created_at":"2026-01-25T18:38:22.000Z","updated_at":"2026-01-25T18:38:22.052Z","avatar_url":"https://github.com/vividus-framework.png","language":"Handlebars","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VIVIDUS documentation\n\nThis is a playbook repo. It's purpose is to keep the way we deploy VIVIDUS documentation and UI customizations.\nWe use\n- [Antora](https://docs.antora.org/) as a static site generator\n- [Asciidoctor](https://asciidoctor.org/docs/) as a documentation format and text processor\n- [Lunr](https://lunrjs.com/) as an offline search engine.\n\n## Local environment\n\n1. Install Node.js\n1. Install Antora and [Antora Lunr Extension](https://gitlab.com/antora/antora-lunr-extension)\n    ```shell\n    npm i -g @antora/cli@3.1.14 @antora/site-generator@3.1.14 @antora/lunr-extension@1.0.0-alpha.10\n    ```\n1. Install and configure an Asciidoctor.js extension that adds a tabs block to the AsciiDoc syntax.\n    ```shell\n    npm i @asciidoctor/tabs@1.0.0-beta.6\n    ln -s \"$(pwd)/node_modules/@asciidoctor/tabs/dist/js/tabs.js\" supplemental-ui/js/vendor/tabs.js\n    ln -s \"$(pwd)/node_modules/@asciidoctor/tabs/dist/css/tabs.css\" supplemental-ui/css/vendor/tabs.css\n    ```\n1. Generate a site\n    ```shell\n    antora antora-playbook-local.yml\n    ```\n\n*IMPORTANT*: the cloned `docs.vividus.dev` repository should be placed by default in the same folder as `vividus` repository (this behavior could be changed in the playbook).\n\n### One liner\n```shell\n npm i -g @antora/cli@3.1.14 @antora/site-generator@3.1.14 @antora/lunr-extension@1.0.0-alpha.10 \u0026\u0026 \\\n git clone https://github.com/vividus-framework/vividus.git \u0026\u0026 \\   \n git clone https://github.com/vividus-framework/docs.vividus.dev.git \u0026\u0026 \\   \n cd docs.vividus.dev \u0026\u0026 \\\n npm i @asciidoctor/tabs@1.0.0-beta.6 \u0026\u0026 \\\n ln -s \"$(pwd)/node_modules/@asciidoctor/tabs/dist/js/tabs.js\" supplemental-ui/js/vendor/tabs.js \u0026\u0026 \\\n ln -s \"$(pwd)/node_modules/@asciidoctor/tabs/dist/css/tabs.css\" supplemental-ui/css/vendor/tabs.css \u0026\u0026 \\\n antora antora-playbook-local.yml \u0026\u0026 \\  \n open ./public/index.html\n ```\n\n### PDF Generation\n1. Install Asciidoctor PDF\n    ```shell\n    gem install asciidoctor-pdf\n    ```\n1. Install the [Antora PDF Extension](https://gitlab.com/antora/antora-assembler/)\n    ```shell\n    npm i -g @antora/pdf-extension\n    ```\n1. Generate a PDF document\n    ```shell\n    antora --extension @antora/pdf-extension antora-playbook-local.yml\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvividus-framework%2Fdocs.vividus.dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvividus-framework%2Fdocs.vividus.dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvividus-framework%2Fdocs.vividus.dev/lists"}