SphinxKnight / action-bi-toolkit.github.io

https://toolkit.action-bi.com/

README

Install Jekyll

• Install Ruby (with Devkit) from https://rubyinstaller.org/downloads/
• On final installer screen, select "ridk install"; Choose option 3 (MSYS2 and MINGW)
• In new command prompt (NB: not running as admin), run gem install jekyll bundler
• Verify installation using jekyll -v

Install site dependencies

• Clone the repo
• Navigate to the /docs folder in repo
• Check the Gemfile for a line starting gem "webrick"
• If the line is missing then type bundle add webrick (see jekyll/jekyll#8523) otherwise skip step
• Install bundle by typing command: bundle

Jekyll Serve

• Navigate to root of repo
• Either execute the following shortcut file ./serve.cmd, or
• Direct command: bundle exec jekyll serve (cd into ./docs first)

TODO

• Jekyll setup / Gemfile
• GA
• Landing Page
• Footer Logo
• Blog
• feed.xml
• Top Nav
• Side Bar
• Remove all obsolete artifacts
• Landing - Fix mobile width
• Blog: Title
• Tools - Getting Started
• Tools: Use https://shields.io/category/version
• Features
• About/Contact
• Search
• jQuery syntax error
• Articles
• Tags
• Commento.io
• Collapsible TOC?
• Favicon

GitHub Pages / Jekyll Docs

• https://jekyllrb.com/docs/
• https://jekyllrb.com/docs/configuration/options/
• https://jekyllrb.com/docs/pages/
• https://jekyllrb.com/docs/posts/
• https://jekyllrb.com/docs/variables/
• https://jekyllrb.com/docs/includes/
• Liquid Reference
• Liquid in Jekyll

External Dependencies

• Font Awesome v4.7
• Bootstrap 3.3.7
• jQuery 3.3.1
• Navgoco jQuery plugin

About: Jekyll Collections

• https://ben.balter.com/2015/02/20/jekyll-collections/

Howto: New Article

Howto: New Post

Howto: Images

Page Composition

• Layout: default
  • Include: head.html
  • Include: topnav.html
  • Include: sidebar.html
  • Content
    • Layout: page
      • Include: toc.html
      • CONTENT
      • Include: footer.html