X-Cart 5 Documentation repo - based on Jekyll site builder
Switch branches/tags
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci [skip ci] fix rsync command Feb 8, 2018
_assets Add spacing between sibling li tags Jul 2, 2018
_data RU: title rename Feb 15, 2018
_includes Keep hash on redirect Jul 19, 2018
_layouts Keep hash on redirect Jul 19, 2018
_pages Update custom_product_tabs.md Dec 14, 2018
_plugins [!] fix swagger jekyll Jun 28, 2018
assets/themes/default/assets Use semantic css via asset pipeline Mar 14, 2018
attachments Create mw_15.png Dec 14, 2018
images [!] Initial commit. Combined docs repos Nov 2, 2017
spec Add files via upload Jun 28, 2018
.gitignore [!] Fix circleci config Nov 8, 2017
.nojekyll [!] Initial commit. Combined docs repos Nov 2, 2017
Gemfile [!] fix swagger jekyll Jun 28, 2018
Gemfile.lock [!] fix swagger jekyll Jun 28, 2018
README.md [skip ci] Update Readme Nov 9, 2017
_config.dev.yml [!] Enable pagination, cache (and fix) navigation Nov 3, 2017
_config.devs_en.yml Update _config.devs_en.yml Jun 28, 2018
_config.devs_ru.yml [!] Add other GA code for RU sites Nov 15, 2017
_config.kb_en.yml [!] Update canonical and sitemap host Nov 10, 2017
_config.kb_ru.yml RU: small correction in title Feb 15, 2018
_config.yml [!] update CI and CSE config Nov 10, 2017
_prose.yml fix sidebar vs redirect pages May 3, 2018
build.sh [!] Fix sitemap and robots templates Nov 13, 2017
get_targets.sh [skip ci] Nov 10, 2017
pages.xml [!] Initial commit. Combined docs repos Nov 2, 2017
robots.txt robots.txt: added ignoring of search.html Nov 12, 2018
sitemap.xml [!] Fix sitemap and robots templates Nov 13, 2017
start.sh [!] Fix sitemap and robots templates Nov 13, 2017

README.md

X-Cart 5 Knowledge Base and Developer Documentation

CircleCI

This is the combined repo of all X-Cart 5 documentation sites. Available sites are:

  • Knowledge Base (English): kb_en
  • Knowledge Base (Russian): kb_ru
  • Developer Docs (English): devs_en
  • Developer Docs (Russian): devs_ru

Requirements

  • Ruby 2.3+
  • Jekyll 3.6+

Usage

Run bundle install first to get the all required gems. After that you have two options:

  1. To build the site in production mode, run ./build.sh <SITE_NAME> (the site name key is specified in bold in "Available sites" list).

  2. To run the site via jekyll serve in development mode, run ./start.sh <SITE_NAME>.

Contribution

You can send pull requests to update the articles content (which is placed in _pages folder). Also, there is an editor, available for the approved contributors from the X-Cart - https://xcart.github.io/prose.