Docs (~) Index

By Amr Abdel Eissa

Index of all doc pages and instructions on how to add new doc sections

Estimated reading time: 6 minutes

Edit on Github
Table of Contents

You have reached the documentation (library) section of this site, which will contain detailed information of various components of this site (e.g., jekyll, bootstrap, etc.). The ultimate goal is to house a documentation site that operates very similar to Microsoft’s doc site here.

These docs are sourced using the git module function, cleaned up with some scripts, and then generated using jekyll. In the future, these docs will have multiple engines to created (i.e., using Hugo to create the docs site).

Current, we have docs for the following applications:

  • Ruby
  • Jekyll
  • Liquid
  • Bootstrap

To add to this collection, you need to run the following commands on your local development environment:

Jekyll

official docs

git submodule add https://github.com/jekyll/jekyll.git jekyll-docs
cd jekyll-docs/docs/_docs
git sparse-checkout init --cone
git sparse-checkout set jekyll-docs/docs/_docs
git sparse-checkout set docs/_docs

Collection Index - docs

page preview image
Cannot Start Jekyll at Specific Port

Handle error ‘Address Already in Use’ when starting Jekyll.

page preview image
Jekyll - Liquid

Useful tricks of Liquid, which are used in Jekyll.

page preview image
Jekyll - Usage and Customization

Customize Jekyll website.

page preview image
Jekyll - Google Analytics - Draft

Use Google Analytics to track website traffic.

page preview image
Jekyll - Social Share Buttons

Create share buttons for the most popular social medias.

page preview image
Jekyll - Social Share Buttons with ShareThis

Integrate ShareThis to Jekyll website.

page preview image
Continuously Deploy Jekyll to GitHub Pages with Travis-CI

Start continuous integration with Travis CI for Jekyll website.

page preview image
Jekyll - Math Symbols with MathJax

Display mathematical notation in web pages with MathJax.

page preview image
Generating Diagrams and Flowcharts with Mermaid

Generate diagrams on web page with Mermaid.

page preview image
page preview image
Jekyll - Pagination

Add pagination buttons for every page.

page preview image
Jekyll - Progress Bar

Show progress bar when page is loading.

page preview image
Jekyll - Highlighting

Highlighting with highlight.js.

page preview image
Deploying Personal Website with Custom Domain

Setup personal website with Github page and custom domain.

page preview image
Deploying Jekyll Website to Netlify

Deploy static website built with Jekyll to Netlify.

page preview image
page preview image
Jekyll - Security

Scan website security vulnerabilities and fix them.

page preview image
Docs (~) Index

You have reached the documentation (library) section of this site, which will contain detailed information of various components of this site (e.g., jekyll, ...

page preview image
Jekyll - Comments with Disqus

Use Disqus to enable reader to comment on Jekyll site.

page preview image
Jekyll Frontmatter CMS

This is a new article on how to use Jekyll and Frontmatter to build a CMS.

page preview image
Jekyll - Diagram with Mermaid

Use Mermaid in Markdown to draw diagrams.

page preview image
Jekyll

Jekyll is a static site generator. It takes text written in your favorite markup language and uses layouts to create a static website. You can tweak the site...

page preview image