{"id":15873402,"url":"https://github.com/blake/nomad-docset-generator","last_synced_at":"2025-04-01T22:28:06.239Z","repository":{"id":39867458,"uuid":"226732931","full_name":"blake/nomad-docset-generator","owner":"blake","description":"Scripts for generating Nomad Dash Docset","archived":false,"fork":false,"pushed_at":"2023-04-12T05:46:12.000Z","size":25,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-07T14:45:31.695Z","etag":null,"topics":["dashdocs","docset","nomad","nomad-docset-generator"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/blake.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":"2019-12-08T21:16:28.000Z","updated_at":"2021-07-18T21:03:32.000Z","dependencies_parsed_at":"2024-12-14T14:46:20.680Z","dependency_job_id":null,"html_url":"https://github.com/blake/nomad-docset-generator","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"b836de29d87af559b92e0ef50e07a482be91e6b1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blake%2Fnomad-docset-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blake%2Fnomad-docset-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blake%2Fnomad-docset-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blake%2Fnomad-docset-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blake","download_url":"https://codeload.github.com/blake/nomad-docset-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246720076,"owners_count":20822844,"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":["dashdocs","docset","nomad","nomad-docset-generator"],"created_at":"2024-10-06T01:02:18.485Z","updated_at":"2025-04-01T22:28:06.214Z","avatar_url":"https://github.com/blake.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nomad Docset generator\n\nThis project is based on [consul-dash-doc-generator](https://github.com/bartoszj/consul-dash-doc-generator).\n\n## Requirements\n\n* [npm](https://www.npmjs.com/)\n* [Ruby](https://www.ruby-lang.org/)\n* [Ruby Version Manager](https://rvm.io/) (RVM)\n\nnpm is used to build the Nomad website. RVM is used to install to Ruby, and\nto manage nomad-docset-generator's associated gems in a dedicated dependency\nenvironment.\n\n## Installation\n\nFirst, install Ruby 2.5.3 using RVM.\n\n```shell\nrvm install 2.5.3\n```\n\nNext, create a dedicated [Gemset](https://rvm.io/gemsets/basics) for nomad-docset-generator.\n\n```shell\nrvm gemset --create use nomad-docset-generator\n```\n\nUse `gem install` to install [Bundler](https://bundler.io/).\n\n```shell\ngem install --no-document bundler\n```\n\nFinally, install the required gems.\n\n```shell\nbundle install\n```\n\n## Build the docset\n\nTo build the docset, use the `build.sh` command. The syntax is as follows:\n\n```shell\n./build.sh \u003cversion\u003e\n```\n\nTo build a docset for Nomad version 1.1.2, execute:\n\n```shell\n./build.sh v1.1.2\n```\n\nThe resultant file will be stored in `./build/\u003cversion\u003e/Nomad.tgz`.\n\n## Install the docset\n\nTo install the docset, first un-archive the file into the current directory.\n\n```shell\ntar --extract --gunzip --file ./build/v1.1.2/Nomad.tgz\n```\n\nInstall the docset by into [Dash](https://kapeli.com/dash) by either double-clicking\nthe file in Finder, or importing it using the following procedure.\n\n1. Open Dash\n1. Preferences (`⌘,`)\n1. Click 'Docsets' from the menu bar\n1. Click '+' and select 'Add Local Docset'\n1. Navigate to Nomad.docset and click 'Open'\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblake%2Fnomad-docset-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblake%2Fnomad-docset-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblake%2Fnomad-docset-generator/lists"}