This is a draft for a Carbon for IBM.com template on Jekyll. Jekyll is integrated by default on GitHub Pages, so it enables a publishing without any user build step to https://pages.github.ibm.com.
The mid-term goal would be to release this as a Jekyll theme for anyone to write internal and external websites easily, with plain markup or more advanced Carbon web components.
To get this to run, you can either just fork this project and start editing one
of the .md files on the gh-pages branch, commit and push the changes. It
will get visible under https://pages.github.ibm.com/[username]/[projectname]
in around 30 seconds.
This repository uses dev containers to avoid version conflicts between the base system and the repository's dependencies (ruby, jekyll). Dev containers require a docker daemon to be running. The easiest IBM-approved way to do so is to to use Rancher Desktop.
- Install Rancher Desktop for your system
- Open Rancher Desktop → Preferences
- Set "Container Engine" to "dockerd (moby)" and apply
- In "Kubernetes", you can uncheck the "Enable Kubernetes" checkbox (optional)
- Install the official "Dev containers" VS Code extension
- Whenever you open this repository in VS Code, you should receive a notification to "Reopen in container". Should you not see this, click on the left-bottom-most icon (><) and select "Reopen in container".
The first time will take a while to download, but any subsequent opening should be fast.
Please note: Rancher Desktop must be running in order for you to connect to the dev container.
In your dev container, running the following command will serve the page locally at localhost:4000:
jekyll serve --livereloadPlease note: After any modification to _config.yml, you must stop the dev
server and run above command again.
In your dev container, running the following command will
build all pages and produce the static _site directory.
jekyll buildFor comments or questions, please contact Stephane Rodet on Slack.
- Jekyll: https://jekyllrb.com
- Carbon for IBM.com: https://www.ibm.com/standards/carbon/
- Carbon for IBM.com Storybook: https://www.ibm.com/standards/carbon/web-components/?path=/docs/overview-getting-started--page