{"id":29190652,"url":"https://github.com/owncloud/docs-ui","last_synced_at":"2026-04-03T00:22:35.032Z","repository":{"id":37359275,"uuid":"143305514","full_name":"owncloud/docs-ui","owner":"owncloud","description":"Custom Antora UI theme for the official ownCloud documentation.","archived":false,"fork":false,"pushed_at":"2025-06-24T05:22:41.000Z","size":3685,"stargazers_count":8,"open_issues_count":19,"forks_count":4,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-07-14T16:57:17.814Z","etag":null,"topics":["documentation","handlebars-js","link-antora","owncloud","owncloud-documentation"],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/owncloud.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,"zenodo":null}},"created_at":"2018-08-02T14:27:19.000Z","updated_at":"2025-06-24T05:20:19.000Z","dependencies_parsed_at":"2023-12-02T05:21:39.642Z","dependency_job_id":"13eca4a5-0f83-48b2-a993-15291780975a","html_url":"https://github.com/owncloud/docs-ui","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/owncloud/docs-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/owncloud","download_url":"https://codeload.github.com/owncloud/docs-ui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/owncloud%2Fdocs-ui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265458535,"owners_count":23769171,"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","handlebars-js","link-antora","owncloud","owncloud-documentation"],"created_at":"2025-07-02T00:10:42.797Z","updated_at":"2026-04-03T00:22:35.024Z","avatar_url":"https://github.com/owncloud.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ownCloud Documentation UI\n\n[![Build Status](http://drone.owncloud.com/api/badges/owncloud/docs-ui/status.svg)](http://drone.owncloud.com/owncloud/docs-ui)\n\n[link-antora-default-ui]: https://gitlab.com/antora/antora-ui-default\n[link-antora]: https://antora.org\n[link-ui_bundle.zip]: https://minio.owncloud.com/documentation/ui-bundle.zip\n[link-readme]: https://github.com/owncloud/docs\n[link-git]: https://git-scm.com\n[link-node]: https://nodejs.org\n[link-gulp-cli]: http://gulpjs.com\n[link-git-package]: https://git-scm.com/downloads\n[link-nvm]: https://github.com/creationix/nvm\n[link-nvm-installation-instructions]: https://github.com/creationix/nvm#installation\n[link-preview]: https://github.com/owncloud/docs/blob/master/docs/build-the-docs.md#viewing-the-html-documentation\n\nThe `docs-ui` repository is a custom version of the [Antora Default UI][link-antora-default-ui], for the [Antora][link-antora] version of the ownCloud documentation.\n\n**Table of Contents**\n\n* [Info](#info)\n* [Contributing](#contributing)\n* [Prerequisites](#prerequisites)\n   * [Git](#git)\n   * [Node](#node)\n   * [Install Dependencies](#install-dependencies)\n   * [Add Packages](#add-packages)\n* [Prepared npm Commands](#prepared-npm-commands)\n* [Preview](#preview)\n   * [Preview Changes Using the ownCloud Documentation](#preview-changes-using-the-owncloud-documentation)\n   * [Previewing Changes using a Demo Antora Build](#previewing-changes-using-a-demo-antora-build)\n\n## Info\n\nNote that in directory `preview-site-src`, the `404.html` file is on purpose but `index.html` file is for internal testing purposes only. The file is recreated in the `public/` directory on each `preview` build and served from there. There is no need to change or copy it.\n\n## Contributing\n\nIf you want to make changes, create a \"_feature_\" branch off of master, make the required changes, and then create a Pull Request (PR) against the _master_ branch.\nIf the PR is accepted and merged, a new `ui-bundle.zip` package file will be created and published to `https://minio.owncloud.com/documentation/ui-bundle.zip` as part of the build pipeline.\n\n## Prerequisites\n\nTo preview the UI changes or to create a local version of a `ui-bundle.zip`, you need to install the following software on your computer.\n\n- [git][link-git] (command: `git`)\n- [Node][link-node] (command: `node`)\n- [Gulp CLI][link-gulp-cli] (command: `gulp`)\n\n### git\n\nFirst, make sure you have git installed.\n\n```Shell\ngit --version\n```\n\nIf git is not installed, download and install the [git package][link-git-package] for your system.\n\n### Node\n\nNext, make sure that you have Node installed.\n\n```Shell\nnode --version\n```\n\nIf this command fails with an error, you don't have Node installed.\nWhile you can install Node from the official packages, we strongly recommend that you use [NVM][link-nvm] (Node Version Manager) to install and manage Node.\n\nFollow the [NVM installation instructions][link-nvm-installation-instructions] to set up NVM on your machine.\nOnce you've installed NVM, open a new terminal and install Node using the following command:\n\n```Shell\nnvm ls-remote | grep \"Latest LTS\"\n\n       ...\n       v18.20.4   (Latest LTS: Hydrogen)\n       v20.18.1   (Latest LTS: Iron)\n       v22.22.0   (Latest LTS: Jod)\n       v24.14.0   (Latest LTS: Krypton)\n```\n\nThen install a suitable LTS version, preferrable \u003e v20. You can install as many versions as you like or need, see example below.\n\n```Shell\nnvm install 22.22.0\n```\n\nList the installed versions\n\n```Shell\nnvm ls\n-\u003e     v22.22.0\ndefault -\u003e 22.22.0 (-\u003e v22.22.0)\n\n...\n```\n\n**Info:** The backend to push to the web also uses node v22, see the `.drone.star` file. It is recommended to stay with the same release if possible.\n\nSwitch to a specific installed version of Node at any time, use the following command:\n\n```Shell\nnvm use 22.22.0\n```\n\n**Important:** If you have additional concurrent terminals open, you must close these terminals first and reopen them to use the new setup.\n\nTo make a particular Node version default in new terminals, type:\n\n```Shell\nnvm alias default 22.22.0\n```\n\nNow that you have Node installed, you can proceed with installing the Gulp CLI and npm.\n\n### Update npm\n\n`npm` should be at minimum version 11.11.0\\\nYou can check this with `npm -v`. If an update is needed, simply run teh following command. Replace `latest` with a version if you want to lock it.\n\n```Shell\nnpm install -g npm@latest\n```\n\n### Install Dependencies\n\nFinally, run the following command to install all dependencies:\n\n```Shell\nnpm install\n```\n\n### Add Packages\n\nIf a new package needs to be added, type the following:\n\n```Shell\nnpm -i \u003cpackage-name\u003e\n```\n\n## Prepared npm Commands\n\nTo see all prepared npm commands, run the following command `npm run`. This will output all commands with their settings, though this makes readability not easy. See the [npm documentation](https://docs.npmjs.com/cli/v11/using-npm/scripts) for more information.\n\nHere is the list of commands and when to use them:\n\n* `npm run lint`  \nLint the UI bundle definition\n* `npm run bundle`  \nGenerate a new `ui-bundle.zip` file for local use\n* `npm run preview`  \nPreview the bundle using the gulp. This previews a demo Antora build.\n\n## Preview\n\n### Preview Changes Using the ownCloud Documentation\n\nIf you want to preview your changes to the UI using the ownCloud documentation instead of demo content then you need to build a local copy of `ui-bundle.zip` and use it when generating the ownCloud documentation in your local development machine.\n\n* First create a local `ui-bundle.zip` with the command described above.\n* Then change into the respective documentation repository and run `npm run antora-dev-bundle`.  \nSee the [Generating the Documentation](https://github.com/owncloud/docs#generating-the-documentation) description for more details.\n\n### Previewing Changes using a Demo Antora Build\n\nThe following example runs a demo Antora **build** (_not ownCloud_) for the documentation site which can be **accessed** on your local development machine at `http://localhost:5252`.\n\nTo view your changes as you are working on them, run the following command:\n\n```Shell\nnpm run preview\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowncloud%2Fdocs-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fowncloud%2Fdocs-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fowncloud%2Fdocs-ui/lists"}