This repository holds the documentation for the BBC GEL Technical Guides. The purpose of the code in this project is to compile and generate the website found at https://bbc.github.io/gel Notice that there is no library or framework here, we're just about documentation.
We love contributors. If you have an idea for how to make an improvement, let us know by creating an issue to discuss your idea. We recommend you familiarise yourself with the process of creating a pull-request in GitHub before proceeding.
Our project is roughly organised into source files and generated documentation files. As writers we work in the Markdown-formatted files in the /src folder. Running the build scripts, described below, will then generate the corresponding web pages in the /docs folder.
Prerequisites: Node.js 8+ (known to work on v8.9.4) and NPM.
cd gelnpm installnpm link
npm run develop
This will watch and compile files, and serve the docs folder on localhost while reloading the browser automatically.
To generate the HTML output into the project docs folder, using the markdown from the project src folder, run this command...
npm run html
To make updates to the generated CSS files from the scss source...
npm run sass
If you have added new JS files to the project, you may include them in the main.js file...
npm run js
Or, if you're feeling like you want it all, try this...
npm run build
This is only an example: https://bbc.github.io/gel/components/hello-world/
It's just HTML, so you only need to open up a web browser :-)
If you're trying to preview the site running off of your desktop, I recommend using the awesome 'serve' module.
From the project base directory simply run...
serve
Then navigate to the resulting server address like so: http://localhost:8888/gel/components/hello-world using whatever hostname and port is appropriate.