Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/Gemfile.lock
/.sass-cache/
/_site/
/Gemfile.lock
7 changes: 7 additions & 0 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Not Found
permalink: /404.html
sitemap: false
---

This page doesn't exist!
16 changes: 8 additions & 8 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
source "https://rubygems.org"
source 'https://rubygems.org'

gem "jekyll"
gem "jekyll-remote-theme"
gem 'jekyll', '3.7.2'

gem "github-pages", group: :jekyll_plugins
group :jekyll_plugins do
gem 'jekyll-feed', '0.9.3'
gem 'jekyll-seo-tag', '2.4.0'
gem 'jekyll-sitemap', '1.2.0'
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

gem "html-proofer"
gem "html-proofer"
21 changes: 21 additions & 0 deletions docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 CloudCannon

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
98 changes: 59 additions & 39 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,51 +1,71 @@
title : Phoenicis Scripts Documentation
name : phoenicis.org
description : The documentation for Phoenicis scripts.
repository : PhoenicisOrg/scripts
title: Phoenicis Scripts Documentation
baseurl:
google_analytics_key:
show_full_navigation: true

remote_theme : mmistakes/minimal-mistakes
minimal_mistakes_skin : air
# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
logo: /siteicon.png
description: The documentation for Phoenicis scripts.
author:
name:
email:
twitter: # twitter username without the @ symbol
social:
name: Phoenicis Scripts Documentation
links:
- https://github.com/PhoenicisOrg/scripts

# -----
# Build

timezone: Etc/UTC

markdown : kramdown
permalink : /:categories/:title/
permalink: pretty

plugins:
- jekyll-paginate
- jekyll-sitemap
- jekyll-gist
- jekyll-seo-tag
- jekyll-feed
- jemoji
- jekyll-remote-theme

# mimic GitHub Pages with --safe
whitelist:
- jekyll-paginate
- jekyll-sitemap
- jekyll-gist
- jekyll-feed
- jemoji
exclude:
- Gemfile
- Gemfile.lock
- LICENCE

include:
- _pages
collections:
docs:
title: Documentation
permalink: /:path/
output: true

encoding: "utf-8"
markdown_ext: "markdown,mkdown,mkdn,mkd,md"

defaults:
# _pages
- scope:
path: "_pages"
type: pages
-
scope:
path: ""
values:
layout: single
author_profile: false
sidebar:
nav: "docs"

author:
name: Phoenicis
github: PhoenicisOrg
layout: default
-
scope:
path: ""
type: "docs"
values:
seo:
type: Article
_comments:
category: Group navigation links with this field
order: Used to sort links in the navigation
_options:
content:
width: 800
height: 2000
-
scope:
path: ""
type: "posts"
values:
_comments:
type: Marks the impact of this release

# HTML Compression
compress_html:
clippings: all
types:
- minor
- major
25 changes: 0 additions & 25 deletions docs/_data/navigation.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "application.json"
permalink: /application-json/
category: Develop
order: 1
toc: false
---

Expand Down
8 changes: 8 additions & 0 deletions docs/_docs/Develop/jsdoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "JSDoc"
category: Develop
order: 7
toc: true
---

The Javascript documentation can be found [here]({{ site.baseurl }}{% link jsdoc/index.html %}).
7 changes: 4 additions & 3 deletions docs/_pages/script-js.md → docs/_docs/Develop/script-js.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "script.js"
permalink: /script-js/
category: Develop
order: 3
toc: true
---

Expand Down Expand Up @@ -62,7 +63,7 @@ new UplayScript()
You can determine the app ID by starting the download and checking the folders in `Ubisoft/Ubisoft Game Launcher/data/`.

### LocalInstallerScript
Installs a local Windows executable. Shows a setup window browse step (see [SetupWizard]({{ site.baseurl }}{% link _pages/setup-wizard.md %})) to query the executable.
Installs a local Windows executable. Shows a setup window browse step (see [SetupWizard]({{ site.baseurl }}{% link _docs/Develop/setup-wizard.md %})) to query the executable.

A basic script looks like:

Expand Down Expand Up @@ -147,7 +148,7 @@ For example, for a steam game:
```

#### Pre/Post install hooks
With the pre/post install hooks, you can specify a function which is executed before/after the installation. The function receives a wine object and the [SetupWizard]({{ site.baseurl }}{% link _pages/setup-wizard.md %}). By default, the pre/post install hooks do nothing.
With the pre/post install hooks, you can specify a function which is executed before/after the installation. The function receives a wine object and the [SetupWizard]({{ site.baseurl }}{% link _docs/Develop/setup-wizard.md %}). By default, the pre/post install hooks do nothing.

These hooks are especially useful to set DLL overrides.
You can find the complete list of available verbs [here](https://github.com/PhoenicisOrg/scripts/tree/master/Engines/Wine/Verbs).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "script.json"
permalink: /script-json/
category: Develop
order: 2
toc: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "SetupWizard"
permalink: /setup-wizard/
category: Develop
order: 6
toc: true
---

Expand Down
3 changes: 2 additions & 1 deletion docs/_pages/utils.md → docs/_docs/Develop/utils.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Utils"
permalink: /utils/
category: Develop
order: 4
toc: false
---

Expand Down
3 changes: 2 additions & 1 deletion docs/_pages/verbs.md → docs/_docs/Develop/verbs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Verbs"
permalink: /verbs/
category: Develop
order: 5
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Best practices"
permalink: /best-practices/
category: General
order: 3
toc: false
---

Expand Down
3 changes: 2 additions & 1 deletion docs/_pages/tools.md → docs/_docs/General/tools.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Tools"
permalink: /tools/
category: General
order: 1
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Translation"
permalink: /translation/
category: General
order: 2
toc: false
---

Expand Down
6 changes: 6 additions & 0 deletions docs/_docs/_defaults.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title:
category:
order: 1
toc: false
---
9 changes: 0 additions & 9 deletions docs/_includes/head/custom.html

This file was deleted.

Loading