{"id":13770875,"url":"https://github.com/doga/geminispace-jsdoc-server","last_synced_at":"2026-02-03T18:32:53.490Z","repository":{"id":239087911,"uuid":"796880328","full_name":"doga/geminispace-jsdoc-server","owner":"doga","description":"A Geminispace server for serving JSDoc documentation.","archived":false,"fork":false,"pushed_at":"2025-08-23T19:21:38.000Z","size":66,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-24T06:27:06.604Z","etag":null,"topics":["deno","gemini-capsule","geminispace","jsdoc","server"],"latest_commit_sha":null,"homepage":"https://jsr.io/@arma/geminispace-jsdoc-server","language":"TypeScript","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/doga.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":"2024-05-06T19:46:20.000Z","updated_at":"2025-08-23T19:21:41.000Z","dependencies_parsed_at":"2025-08-24T01:58:05.430Z","dependency_job_id":"17c10a73-5690-4658-84d4-1ed773d914de","html_url":"https://github.com/doga/geminispace-jsdoc-server","commit_stats":null,"previous_names":["doga/doc-server"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/doga/geminispace-jsdoc-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doga%2Fgeminispace-jsdoc-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doga%2Fgeminispace-jsdoc-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doga%2Fgeminispace-jsdoc-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doga%2Fgeminispace-jsdoc-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doga","download_url":"https://codeload.github.com/doga/geminispace-jsdoc-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doga%2Fgeminispace-jsdoc-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29052632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T15:43:47.601Z","status":"ssl_error","status_checked_at":"2026-02-03T15:43:46.709Z","response_time":96,"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":["deno","gemini-capsule","geminispace","jsdoc","server"],"created_at":"2024-08-03T17:00:43.561Z","updated_at":"2026-02-03T18:32:53.484Z","avatar_url":"https://github.com/doga.png","language":"TypeScript","funding_links":[],"categories":["Servers"],"sub_categories":["Graphical"],"readme":"# ♊️ Geminispace JSDoc server\n\n[![JSR](https://jsr.io/badges/@arma/geminispace-jsdoc-server)](https://jsr.io/@arma/geminispace-jsdoc-server)\n\nA [Geminispace](https://geminiquickst.art/) server for serving [JSDoc](https://jsdoc.app/) documentation with the [Deno 2+](https://deno.com/) TypeScript runtime.\n\n## What is Geminispace?\n\nGeminispace is a new Web-like content platform with its own protocol and its own Markdown-like content format. It is especially suitable for browsing content from the terminal. Recommended Gemini client: [amfora](https://github.com/makew0rld/amfora?tab=readme-ov-file#amfora).\n\n## Usage\n\n### 1. Create a TLS certificate and private key\n\n```shell\nTLS_CERT=./path/to/cert.pem \\\nTLS_CERT_KEY=./path/to/key.pem \u0026\u0026 \\\nopenssl req -x509 -newkey rsa:2048 -keyout $TLS_CERT_KEY -out $TLS_CERT -days 365 -nodes\n```\n\nCertificate validity is set to one year by default, and must normally be regenerated periodically.\n\n### 2. Create JSDoc JSON files from the source code\n\nDo this each time the JSDoc in the source code changes:\n\n```shell\ndeno doc --json --name=MODULENAME ./path/to/mod.mjs \u003e ./path/to/jsdoc/MODULENAME/jsdoc.json\n```\n\nThe server does not need a restart to serve new content.\n\nNote that the `jsdoc` directory has a strict structure. It can contain:\n\n- a `jsdoc.json` file at the root, and\n- any number of module directories, each containing a `jsdoc.json` file.\n\nAdditional requirements:\n\n- The `jsdoc` directory can be zero or one directory deep.\n- The name `jsdoc.json` is mandatory for the output of `deno doc`.\n\n### 3. Run the JSDoc server\n\n```shell\nJSDOC_DIR='./jsdoc' \\\nTLS_CERT='./cert/cert.pem' \\\nTLS_CERT_KEY='./cert/key.pem' \\\nCACHE_SIZE='100' \\\nHOSTNAME='0.0.0.0' \\\nPORT='1965' \\\ndeno run --allow-env --allow-net --allow-read \\\njsr:@arma/geminispace-jsdoc-server@3.0.9/main\n```\n\nAll environment variables are optional. The command above shows their default values.\n\n`CACHE_SIZE` defines the size of the in-memory cache. 1 means 10 000 bytes. 0 disables the cache.\n\n## Dependencies\n\nThis TypeScript module depends on [qgeminiserver](https://github.com/doga/qgeminiserver).\n\n```mermaid\n---\ntitle: Dependencies\n---\nflowchart LR\nGeminispaceJSDocServer[geminispace-jsdoc-server] --imports--\u003e QGeminiServer[qgeminiserver]\n```\n\n## To do\n\nCurrent status:\n\n- Only classes, constructors and methods are listed.\n- Setter methods are not listed.\n\n## Live servers\n\nThese Geminispace capsules are running on `geminispace-jsdoc-server`:\n\n- __Qworum JSDoc server__: [gemini://qworum-jdoc.ddns.net/](gemini://qworum-jdoc.ddns.net/)\n\nTo add your capsule here, simply send a pull request.\n\n∎\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoga%2Fgeminispace-jsdoc-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoga%2Fgeminispace-jsdoc-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoga%2Fgeminispace-jsdoc-server/lists"}