{"id":18720046,"url":"https://github.com/geops/geops-docjs-template","last_synced_at":"2025-11-10T19:30:26.031Z","repository":{"id":37810305,"uuid":"200009060","full_name":"geops/geops-docjs-template","owner":"geops","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-06T02:03:46.000Z","size":3149,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-28T11:25:00.691Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/geops.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}},"created_at":"2019-08-01T08:22:50.000Z","updated_at":"2021-11-11T13:54:50.000Z","dependencies_parsed_at":"2023-02-05T02:15:23.531Z","dependency_job_id":null,"html_url":"https://github.com/geops/geops-docjs-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geops%2Fgeops-docjs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geops%2Fgeops-docjs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geops%2Fgeops-docjs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geops%2Fgeops-docjs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geops","download_url":"https://codeload.github.com/geops/geops-docjs-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239581748,"owners_count":19662960,"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":[],"created_at":"2024-11-07T13:29:14.392Z","updated_at":"2025-11-10T19:30:22.535Z","avatar_url":"https://github.com/geops.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# geOps theme for documentation.js\n\nThis is a custom theme for [documentation.js](http://documentation.js.org)\n\nBased on work from: https://github.com/kalinchernev/documentation-theme-ecl/\n\n## Options\n\nThe theme is ready to accept the following options from your configuration:\n\n- `project-name`\n- `project-description`\n- `project-url`\n\n## Usage\n\n### CLI\n\nUse the [documentation.js CLI](https://github.com/documentationjs/documentation/blob/master/docs/USAGE.md)\n\nExample:\n\n```bash\n$ npx documentation build **/_types/*.js --theme . -f html -o example/app\n```\n\nWhere the `--theme` flag should point to the module (index.js) of the theme.\n\n### Node API\n\nSee [the html generation script](./example/scripts/docs-html.js) for an example of the\n`formats.html` method as pointed out in the [documentation pages](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md).\n\n## Theme development\n\nRequirements:\n\n- Node.js current (8.x recommended)\n- `yarn` or `npm`\n\nThere are a few `npm` script tasks which you can use:\n\n- `develop:assets`\n- `develop:theme`\n- `develop:server`\n\nOrder is important, so it's recommended you start a separate terminal session for each task.\n\n### Develop assets\n\nTakes care of CSS and JavaScript assets.\n\n- Makes use of `webpack` CLI.\n- Automatically discovers configuration from `webpack.config.js`\n- Bundles assets to `assets/bundle`\n- Watches for changes.\n\n### Develop theme\n\nTakes care of templates.\n\n- Makes use of `documentationjs` CLI.\n- Takes input of glob patterns where documentation should be extracted from.\n- Builds HTML from underscore templates and moves `images`, `favicon` and `bundle` folders into a target `dist` folder. Thus, ensure that assets are bundled before they are moved.\n- Watches for changes\n\n### Develop server\n\nDelivers results to the browser and reloads on changes.\n\n- Makes use of `reload` CLI.\n- Takes input of `dist` folder where `develop:theme` stores its results.\n- Can optionally listen to different ports if necessary.\n- Serves `dist` folder as a static site\n- Reloads when there are changes in `dist` folder.\n\n## Maintenance notes\n\nPlease commit the results of `develop:assets` in `assets/bundle`. This simplifies the workflow of publishing them to `npm`.\nRaw/Source styles and scripts in `assets/js` and `assets/styles` are ignored and not published to `npm`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeops%2Fgeops-docjs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeops%2Fgeops-docjs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeops%2Fgeops-docjs-template/lists"}