Skip to content

Commit

Permalink
TE-8667 Adjusted configuration and navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
asaulenko committed Mar 29, 2021
1 parent bc99999 commit bd6c7f5
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 23 deletions.
2 changes: 2 additions & 0 deletions .bundle/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
BUNDLE_PATH: "vendor/bundle"
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ _pdf
.DS_Store
.idea
vendor/
.bundle/
9 changes: 3 additions & 6 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
repository: spryker/docs
repository: spryker/spryker.github.io

output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
Expand All @@ -12,7 +12,7 @@ site_title: Spryker Documentation
company_name: Spryker
# this appears in the footer

github_editme_path: spryker/docs/blob/master/
github_editme_path: spryker/spryker.github.io/blob/master/
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.

google_analytics: ""
Expand Down Expand Up @@ -60,21 +60,18 @@ defaults:
type: "pages"
values:
sidebar: marketplace_developer_sidebar
permalink: "/marketplace/dev/:basename"
-
scope:
path: "docs/marketplace/user"
type: "pages"
values:
sidebar: marketplace_user_sidebar
permalink: "/marketplace/user/:basename"
-
scope:
path: "theme_manual"
type: "pages"
values:
sidebar: mydoc_sidebar
permalink: ":basename:output_ext"

# these are defaults used for the frontmatter for these file types

Expand All @@ -83,7 +80,7 @@ sidebars:
- marketplace_user_sidebar
- mydoc_sidebar

description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
description: "Spryker documentation center."
# the description is used in the feed.xml file

# needed for sitemap.xml file only
Expand Down
12 changes: 6 additions & 6 deletions _data/sidebars/marketplace_developer_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,37 @@ entries:
output: web
folderitems:
- title: System requirements
url: /marketplace/dev/system-requirements
url: /docs/marketplace/dev/setup/system-requirements.html
output: web

- title: Installation
url: /marketplace/dev/installation
url: /docs/marketplace/dev/setup/installation.html
output: web

- title: Post-installation steps
url: /marketplace/dev/post-installation-steps
url: /docs/marketplace/dev/setup/post-installation-steps.html
output: web

- title: Feature integration guides
output: web

folderitems:
- title: Feature integration guides sample page
url: /marketplace/dev/fig-sample-page
url: /docs/marketplace/dev/feature-integration-guides/fig-sample-page.html
output: web

- title: Glue API guides
output: web

folderitems:
- title: Glue API guides sample page
url: /marketplace/dev/glue-api-sample-page
url: /docs/marketplace/dev/glue-api-guides/glue-api-sample-page.html
output: web

- title: HowTos
output: web

folderitems:
- title: HowTos sample page
url: /marketplace/dev/howtos-sample-page
url: /docs/marketplace/dev/howtos/howtos-sample-page.html
output: web
2 changes: 1 addition & 1 deletion _data/sidebars/marketplace_user_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ entries:
output: web
folderitems:
- title: Item 1
url: "/marketplace/user/item-1"
url: /docs/marketplace/user/section-1/item-1.html
output: web

- title: Item 2
Expand Down
2 changes: 1 addition & 1 deletion _data/sidebars/mydoc_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

entries:
- title: sidebar
product: Jekyll Doc Theme
product: Theme Manual
version: 6.0
folders:

Expand Down
14 changes: 9 additions & 5 deletions _data/topnav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,21 @@ topnav:
- title: Topnav
items:
- title: GitHub
external_url: https://github.com/tomjoht/documentation-theme-jekyll
external_url: https://github.com/spryker/docs

#Topnav dropdowns
topnav_dropdowns:
- title: Topnav dropdowns
folders:
- title: Products
- title: Help
folderitems:
- title: Jekyll Documentation Theme
- title: Jekyll documentation
external_url: http://jekyllrb.com/docs/home/
- title: Theme manual
url: /mydoc_introduction.html
- title: Products
folderitems:
- title: Developer Documentation
url: /marketplace/dev/system-requirements.html
url: /docs/marketplace/dev/setup/system-requirements.html
- title: User Documentation
url: /marketplace/user/item-1
url: /docs/marketplace/user/section-1/item-1
2 changes: 1 addition & 1 deletion _includes/topnav.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: '{{ "search.json" }}',
dataSource: '{{ "/search.json" }}',
searchResultTemplate: '<li><a href="{url}" title="{{page.title | escape }}">{title}</a></li>',
noResultsText: '{{site.data.strings.search_no_results_text}}',
limit: 10,
Expand Down
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ permalink: index.html
summary: This is a dummy index page.
---

* [Marketplace developer guides](/marketplace/dev/system-requirements)
* [Marketplace user guides](/marketplace/user/item-1)
* [Marketplace developer guides](/docs/marketplace/dev/setup/system-requirements)
* [Marketplace user guides](/docs/marketplace/user/section-1/item-1)
* [Theme manual](get_started)

0 comments on commit bd6c7f5

Please sign in to comment.