{"id":18377231,"url":"https://github.com/bbc/gel","last_synced_at":"2025-04-06T21:31:29.924Z","repository":{"id":37926933,"uuid":"149146072","full_name":"bbc/gel","owner":"bbc","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-27T15:15:08.000Z","size":32441,"stargazers_count":44,"open_issues_count":53,"forks_count":16,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-22T06:51:18.977Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://bbc.github.io/gel","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/bbc.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-17T15:23:02.000Z","updated_at":"2025-03-20T13:13:14.000Z","dependencies_parsed_at":"2024-11-06T00:38:43.299Z","dependency_job_id":null,"html_url":"https://github.com/bbc/gel","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/bbc%2Fgel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fgel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fgel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fgel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbc","download_url":"https://codeload.github.com/bbc/gel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247555080,"owners_count":20957701,"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-06T00:27:22.928Z","updated_at":"2025-04-06T21:31:26.459Z","avatar_url":"https://github.com/bbc.png","language":"JavaScript","readme":"# bbc/gel Technical Guides\n\n## Summary\n\nThis repository holds the source for the _documentation_ that explains the BBC GEL Technical Guides: the result of running this project is to produce the static HTML-based website found at https://bbc.github.io/gel.\n\nNotice that there is *no library or framework here*, we're just documentation all the way down.\n\n## Contributing\n\nWe love contributors. If you have an idea for how to make an improvement, let us know by [creating an issue to discuss your idea](https://github.com/bbc/gel/issues). We recommend you familiarise yourself with [the process of creating a pull-request in GitHub](https://help.github.com/en/articles/creating-a-pull-request) before proceeding.\n\n[Raising an issue](https://github.com/bbc/gel/issues) is a great way to contribute! Let us know if you spotted anything that can be fixed or improved or if you have an idea for a change. You don't need to have any special software or developer skillz to raise an issue or make a suggestion, just pop onto our public GitHub website and let us know!\n\nIf you do want to work with our source files, you will need to have the `git` commandline  tool (or the [GitHub Desktop client](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop)) installed. With `git` you can [`clone` our repository](https://www.youtube.com/watch?v=CKcqniGu3tA) onto your own computer and get hacking! This project's files are roughly organised into [source files](https://github.com/bbc/gel/tree/master/_content) and generated [documentation files](https://github.com/bbc/gel/tree/master/docs). As authors we work in the [Markdown](https://learnxinyminutes.com/docs/markdown/)-formatted files in the `/_content` folder.\n\nRunning the build scripts, described below, will then generate the corresponding web pages in the `/docs` folder. Use `git` to commit and [create a pull request](https://opensource.com/article/19/7/create-pull-request-github). We'll take it from there!\n\n## Installation\n\nPrerequisites:\n\n* This requires [`npm` and `node` commandline tools to be installed](https://nodejs.dev/learn/how-to-install-nodejs). this process is known to work on NodeJS v12.x.\n```\n$ node -v\n  v12.13.0\n$ npm -v\n  6.12.0\n```\n* Global [`sass`](https://www.npmjs.com/package/sass) binary installed: Like `npm i sass -g`\n```\n$ sass --version\n  1.34.1 compiled with dart2js 2.13.1\n```\n* Global [`uglifyjs`](https://www.npmjs.com/package/uglify-js) binary installed: Like `npm i uglify-js -g`\n```\n$ uglifyjs --version\n  uglify-js 3.11.6\n```\n* Global [`gulp`](https://www.npmjs.com/package/gulp) binary installed: Like `npm i gulp -g`\n```\n$ gulp --version\n  CLI version: 2.3.0\n```\n\nTo install:\n```\n$ git clone https://github.com/bbc/gel.git\n$ cd gel\n$ npm install\n$ npm link\n```\n\n## Develop\n- `npm run watch`\n\nThis will use `gulp` to watch and compile files, and serve the `docs` folder on localhost while reloading the browser automatically.\n\n## Build\nTo generate the HTML output into the project `docs` folder, using the markdown from the project `src` folder, run this command...\n\n- `npm run html`\n\nTo make updates to the generated CSS files from the `scss` source...\n\n- `npm run sass`\n\nIf you have added new JS files to the project, you may include them in the `main.js` file...\n\n- `npm run js`\n\nOr, if you're feeling like you want it all, try this...\n\n- `npm run build`\n\n## Example\n\nThis is only an example: https://bbc.github.io/gel/components/hello-world/\n\n## Testing\n\nIt's just HTML, so you only need to open up a web browser :-)\n\nIf you're trying to preview the site running off of your desktop, you can run the `serve` script:\n\nFrom the project base directory...\n\n- `npm run serve`\n\nThen navigate to the resulting server address like `http://localhost:3000/components/hello-world` (or using whatever hostname and port is appropriate).\n\n## Licence\n\nThe code in this repository is used to generate our documentation and is unlicenced. The generated documentation itself is published at \u003chttps://bbc.github.io/gel/\u003e and is licenced under the [Open Government Licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/), unless otherwise noted.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbc%2Fgel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbc%2Fgel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbc%2Fgel/lists"}