This is the repository for the atomiq.io website. This is a Jekyll-based static websitre that is hosted directly from this repo using GitHub Pages.
You can run the website locally while editing. You will need several Ruby based tools for this.
-
Install Ruby and Bundler if you don't have them already.
-
Install the jekyll-redirect-from gem:
$ gem install jekyll-redirect-from
-
cdto the repository directory and run the following command:$ bundle install
Bundler will look in the Gemfile for which gems to install. The github-p ages gem includes the same version of Jekyll and other dependencies as used by GitHub Pages, so that your local setup mirrors GitHub Pages as closely as possible.
Run Jekyll using the following command:
$ bundle exec jekyll serve
Then, load http://localhost:4000/ on your browser.
Jekyll uses a variant (essentially a superset) of Markdown called Kramdown.
Jekyll uses the Liquid template engine for templating.
You can use http://kramdown.gettalong.org/parser/gfm.html fenced code blocks for code specific syntax highlighting; for example:
var express = require('express');
var app = express();
app.listen(3000);The default GitHub Pages syntax highlighting has been disabled in _config.yml to allow highlighting with prism.js.
Feel free to make changes to the template files or the document files. The supporting docs are located in their respective directories, and the API docs are located under the _includes directory.
index.md
_includes/header/header-en.html
The menus are mapped to markdown files located in the en directory for the actual content.
_includes/header/footer-en.html
_includes/head.html
_layouts/home.html
_layouts/page.html
en/starteren/guideen/1xen/advanceden/resources
API content files are actually located here: _includes/api/en/1x. Make sure to keep the following files synced so API redirects correctly point to the API content files.
api.mden/api.mden/1x/api.md
The reason is to handle the following redirects:
Again, these three files handle redirects and need to be kept in sync, but the actual content files are located in _includes/api/en/1x. These three files are responsible for displaying the navigation sidebar for API pages.
cssfontsimagesjs
README.md is for the benefit of the repo and isn't published as part of the site.
Gemfile is used by bundle (bundle install) for all the ruby gem dependencies, but you can also install all dependencies in the Gemfile manually (gem install jekyll, etc). The gems are all for Jekyll development for GitHub Pages.
_config.yml is used by Jekyll