Skip to content

Commit

Permalink
[FIX] Documentations.
Browse files Browse the repository at this point in the history
  • Loading branch information
Seiger committed Jan 9, 2024
1 parent 6be967f commit 1636ea0
Show file tree
Hide file tree
Showing 78 changed files with 10,169 additions and 65 deletions.
1 change: 1 addition & 0 deletions config/sLangCheck.php
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php return ['check_sLang' => true];
24 changes: 24 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
source "https://rubygems.org"
ruby RUBY_VERSION

# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
# gem "jekyll", "3.2.1"

# This is the default theme for new Jekyll sites. You may change this to anything you like.
# gem "minima"

# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
# group :jekyll_plugins do
# gem "jekyll-github-metadata", "~> 1.0"
# end
87 changes: 83 additions & 4 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,83 @@
title: sLang Docs
remote_theme: just-the-docs/just-the-docs
plugins:
- jekyll-remote-theme
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing these this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

# See more https://vsoch.github.io/tw-jekyll/

title: sCommerce
email: info@seigerit.com
author: Serhii Korneliuk
description: sCommerce is a set of e-commerce tools for Evolution CMS.

# Add your baseurl here (your repository) but DO NOT CHANGE THE LINE NUMBER without editing .circleci/circle_urls.sh
baseurl: "/sCommerce" # the subpath of your site, e.g. /blog

# This is mostly for testing
url: "https://seiger.github.io" # the base hostname & protocol for your site

# Keywords (space separated)
keywords: "documentation sCommerce"

# Add colorful permalinks to headers
# change colors in _includes/permalinks.html
add_permalinks: true

# Optional
#twitter: vsoch
linkedin: seiger-kor
support: https://github.com/Seiger/sCommerce/issues
repo: https://github.com/Seiger/sCommerce
github_user: seiger
github_repo: sCommerce
# discord: https://community.discord.com

# If you have a logo, put here to include in meta tags
logo: assets/img/logo.svg

# branch to edit on GitHub
github_branch: main

# If not set, badge color (background) defaults to violet
# badge_color: "#2bcf98"
badge_rounded: true

# Build settings
markdown: kramdown

# If you add tags to pages, define this variable to link them to some external search
# If you want to link to tags locally on the site, leave this commented out
# tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
tag_color: primary # danger, success, warning, primary, info, secondary

accentColor: red # purple, green, etc.
themeColor: red # purple, green, blue, orange, purple, grey
fixedNav: 'true' # true or false

permalink: /:year/:title/
exclude: [_site, CHANGELOG.md, LICENSE, README.md, vendor]

# Collections
collections:
docs:
output: true
permalink: /:collection/:path

# Defaults
defaults:
- scope:
path: ""
type: "pages"
values:
layout: "page"
4 changes: 4 additions & 0 deletions docs/_data/navigation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- title: About
url: about
- title: Documentation
url: docs
9 changes: 9 additions & 0 deletions docs/_data/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
- title: Documentation
url:
links:
- title: "Getting Started"
url: "getting-started"
- title: "Management tabs"
url: "management"
- title: "Use in Blade"
url: "use-in-blade"
4 changes: 4 additions & 0 deletions docs/_includes/alert.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div class="alert alert-{{ include.type }}" role="alert">
<h4 class="alert-heading">{% if include.title %}{{ include.title }}{% else %}{{ include.type }}{% endif %}</h4>
{{ include.content }}
</div>
2 changes: 2 additions & 0 deletions docs/_includes/badge.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<span style="font-size:12px" class="inline-flex items-center justify-center px-2 py-1 mr-2 text-xs font-bold leading-none text-sky-100 bg-sky-600 rounded-full" {% if include.style %}style="{{ include.style }}{% endif %}"><a style="cursor:pointer; color:white">{{ include.text }}</a></span>

2 changes: 2 additions & 0 deletions docs/_includes/callout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

<div class="callout" {% if include.color %}style="background-color: {{ include.color }}"{% endif %}>{{ include.text }}</div>
1 change: 1 addition & 0 deletions docs/_includes/doc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<a href="{{ site.baseurl }}/docs/{{ include.path }}">{% if include.name %}{{ include.name }}{% else %}{{ include.path }}{% endif %}</a>
58 changes: 58 additions & 0 deletions docs/_includes/feedback.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{% if site.feedback %}<style>
.feedback--answer {
display: inline-block;
}
.feedback--answer-no {
margin-left: 1em;
}
.feedback--response {
display: none;
margin-top: 1em;
}
.feedback--response__visible {
display: block;
}
</style>
<h5 class="feedback--title">Feedback</h5>
<p class="feedback--question">Was this page helpful?</p>
<button class="feedback--answer feedback--answer-yes">Yes</button>
<button class="feedback--answer feedback--answer-no">No</button>
<p class="feedback--response feedback--response-yes">
Glad to hear it! Please <a href="{{ site.repo }}/issues/new">tell us how we can improve</a>.
</p>
<p class="feedback--response feedback--response-no">
Sorry to hear that. Please <a href="{{ site.repo }}/issues/new">tell us how we can improve</a>.
</p>
<script>
const yesButton = document.querySelector('.feedback--answer-yes');
const noButton = document.querySelector('.feedback--answer-no');
const yesResponse = document.querySelector('.feedback--response-yes');
const noResponse = document.querySelector('.feedback--response-no');
const disableButtons = () => {
yesButton.disabled = true;
noButton.disabled = true;
};
const sendFeedback = (value) => {
if (typeof ga !== 'function') return;
const args = {
command: 'send',
hitType: 'event',
category: 'Helpful',
action: 'click',
label: window.location.pathname,
value: value
};
ga(args.command, args.hitType, args.category, args.action, args.label, args.value);
};
yesButton.addEventListener('click', () => {
yesResponse.classList.add('feedback--response__visible');
disableButtons();
sendFeedback(1);
});
noButton.addEventListener('click', () => {
noResponse.classList.add('feedback--response__visible');
disableButtons();
sendFeedback(0);
});
</script>{% endif %}<br/>

2 changes: 2 additions & 0 deletions docs/_includes/figure.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<figure> <img src="{{ site.baseurl }}/{{ include.path }}" srcset="{{ site.baseurl }}/{{ include.path }} 2x" alt=""></figure>

9 changes: 9 additions & 0 deletions docs/_includes/google-analytics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% if site.google-analytics %}<script async src='https://www.google-analytics.com/analytics.js'></script>
<script type="application/javascript">
var doNotTrack = false;
if (!doNotTrack) {
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', '{{ site.google-analytics }}', 'auto');
ga('send', 'pageview');
}
</script>{% endif %}
45 changes: 45 additions & 0 deletions docs/_includes/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="keywords" content="Seiger {{ site.keywords }}">
<meta name="robots" CONTENT="INDEX, FOLLOW">
<link rel="shortcut icon" href="{{ site.baseurl }}/assets/favicons/favicon.ico" >
<link rel="apple-touch-icon" href="{{ site.baseurl }}/assets/favicons/apple-touch-icon.png" sizes="180x180">
<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/favicon-16x16.png" sizes="16x16">
<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicons/android-chrome-512x512.png" sizes="512x512">
<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
<meta property="og:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}" />
<meta property="og:description" content="{% if page.description %}{{ page.description }}{% else %}{{ site.description }}{% endif %}" />
<meta property="og:type" content="website" />
<meta property="og:url" content="{{ site.url }}" />
<meta property="og:site_name" content="{{ site.url }}" />
<meta itemprop="name" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}">
<meta name="description" itemprop="description" content="{% if page.description %}{{ page.description | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}"/>
<meta name="twitter:description" content="{% if page.description %}{{ page.description | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}"/>
{% if site.logo %}<meta name="twitter:image" content="{{ site.baseurl }}{{ site.logo }}">{% endif %}
<meta name="referrer" content="origin">
<meta name="HandheldFriendly" content="True">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="msapplication-TileColor" content="#2b5797">
<meta name="theme-color" content="#2b5797">
<meta property="og:locale" content="en">
<meta property="og:type" content="article">
{% if site.logo %}<meta property="og:image" content="{{ site.baseurl }}{{ site.logo }}">{% endif %}
<style>@font-face{font-family:'Inter';src:url({{ site.baseurl }}/assets/fonts/inter-light.woff2)format('woff2');font-weight:300;font-style:normal;}@font-face{font-family:'Inter';src:url({{ site.baseurl }}/assets/fonts/inter-regular.woff2)format('woff2');font-weight:400;font-style:normal;}@font-face{font-family:'Inter';src:url({{ site.baseurl }}/assets/fonts/inter-medium.woff2)format('woff2');font-weight:500;font-style:normal;}@font-face{font-family:'Inter';src:url({{ site.baseurl }}/assets/fonts/inter-semibold.woff2)format('woff2');font-weight:600;font-style:normal;}@font-face{font-family:'Inter';src:url({{ site.baseurl }}/assets/fonts/inter-bold.woff2)format('woff2');font-weight:700;font-style:normal;}@font-face{font-family:'Mackinac';src:url({{ site.baseurl }}/assets/fonts/mackinac-bold.woff2)format('woff2');font-weight:700;font-style:normal;}@font-face{font-family:'Native';src:url({{ site.baseurl }}/assets/fonts/native-regular.woff2)format('woff2');font-weight:400;font-style:normal;}@font-face{font-family:'Native';src:url({{ site.baseurl }}/assets/fonts/native-bold.woff2)format('woff2');font-weight:700;font-style:normal;}</style>
<script>var fontsInServiceWorker=sessionStorage.foutFontsStage1Loaded&&sessionStorage.foutFontsStage2Loaded||"serviceWorker"in navigator&&null!==navigator.serviceWorker.controller&&"activated"===navigator.serviceWorker.controller.state;if(!fontsInServiceWorker&&"fonts"in document){function fetchFonts(o){return Promise.all(o.map(function(o){return document.fonts.load(o)}))}sessionStorage.foutFontsStage2Loaded?document.documentElement.className+=" wf-loaded-stage2":sessionStorage.foutFontsStage1Loaded=!0}if("fonts"in document){let o=new FontFace("Inter","url({{ site.baseurl }}/assets/fonts/inter-light.woff2) format('woff2')",{weight:"300"}),e=new FontFace("Inter","url({{ site.baseurl }}/assets/fonts/inter-regular.woff2) format('woff2')",{weight:"400"}),t=new FontFace("Inter","url({{ site.baseurl }}/assets/fonts/inter-medium.woff2) format('woff2')",{weight:"500"}),n=new FontFace("Inter","url({{ site.baseurl }}/assets/fonts/inter-semibold.woff2) format('woff2')",{weight:"600"}),a=new FontFace("Inter","url({{ site.baseurl }}/assets/fonts/inter-bold.woff2) format('woff2')",{weight:"700"}),r=new FontFace("Mackinac","url({{ site.baseurl }}/assets/fonts/mackinac-bold.woff2) format('woff2')",{weight:"700"}),f=new FontFace("Native","url({{ site.baseurl }}/assets/fonts/native-regular.woff2) format('woff2')",{weight:"400"}),i=new FontFace("Native","url({{ site.baseurl }}/assets/fonts/native-bold.woff2) format('woff2')",{weight:"700"});Promise.all([o.load(),e.load(),t.load(),n.load(),a.load(),r.load(),f.load(),i.load()]).then(o=>{o.forEach(o=>document.fonts.add(o)),document.documentElement.classList.add("wf-loaded-stage2"),sessionStorage.foutFontsStage2Loaded=!0}).catch(o=>{throw new Error(`Error caught: ${o}`)})}(sessionStorage.foutFontsStage1Loaded&&sessionStorage.foutFontsStage2Loaded||"serviceWorker"in navigator&&null!==navigator.serviceWorker.controller&&"activated"===navigator.serviceWorker.controller.state)&&document.documentElement.classList.add("wf-loaded-stage2");</script>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/inter-light.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/inter-regular.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/inter-medium.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/inter-semibold.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/inter-bold.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/mackinac-bold.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/native-regular.woff2" as="font" type="font/woff2" crossorigin>
<link rel="preload" href="{{ site.baseurl }}/assets/fonts/native-bold.woff2" as="font" type="font/woff2" crossorigin>
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/tailwind2.css" media="all">
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css" media="all">
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/docsearch.css" media="all">
</head>
56 changes: 56 additions & 0 deletions docs/_includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<header>
<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
<a class="navbar-brand" href="{{ site.baseurl }}/">
<span class="navbar-logo"></span>{% include logo.svg %}<span class="text-uppercase font-weight-bold">{{ site.title }}</span>
</a>
<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
<ul class="navbar-nav mt-2 mt-lg-0">
{% if site.repo %}
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link" href="{{ site.repo }}" target="_blank"><span>GitHub</span></a>
</li>
{% endif %}
{% for link in site.data.navigation %}
<li class="nav-item mr-4 mb-2 mb-lg-0">
<a class="nav-link" href="{% if link.url %}{{ site.baseurl }}/{{ link.url }}{% else %}{{ link.external_url }}{% endif %}">
<span>{{ link.title }}</span>
</a>
</li>
{% endfor %}
</ul>
</div>

<div class="navbar-nav d-none d-lg-block">
<input type="search" class="form-control td-search-input" placeholder="&#xf002 Search this site…" aria-label="Search this site…" autocomplete="off">
</div>

<div class="navbar-nav d-none d-lg-block">
<a class="gh-source" data-gh-source="github" href="{{ site.repo }}" title="Go to repository" data-md-state="done">
<div class="gh-source__repository">
<i class="fab fa fa-github fa-2x" style='padding-right:20px; float:left; margin-top:5px'></i> {{ site.github_user }}/{{ site.github_repo }}
<ul class="gh-source__facts">
<li class="gh-source__fact" id='stars'></li>
<li id="forks" class="gh-source__fact"></li>
</ul>
</div>
</a>
</div>
</nav>
</header>

<script>
$(document).ready(function() {
var url = "https://api.github.com/search/repositories?q={{ site.github_user }}/{{ site.github_repo }}";
fetch(url, {
headers: {"Accept":"application/vnd.github.preview"}
}).then(function(e) {
return e.json()
}).then(function(r) {
console.log(r.items[0])
stars = r.items[0]['stargazers_count']
forks = r.items[0]['forks_count']
$('#stars').text(stars + " Stars")
$('#forks').text(forks + " Forks")
});
});
</script>
5 changes: 5 additions & 0 deletions docs/_includes/logo-menu.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<nav aria-label="Logo menu" class="flex md:w-60 relative z-50">
<a href="{{ site.baseurl }}/">
<p style="font-size:25px; font-family: Mackinac,ui-serif,Georgia,Cambria,Times New Roman,Times,serif; font-weight: 700;">{{ site.title }}</p>
</a>
</nav>
Loading

0 comments on commit 1636ea0

Please sign in to comment.