Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SirLich committed Aug 22, 2021
1 parent c5dec56 commit 75820c2
Show file tree
Hide file tree
Showing 17 changed files with 250 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_site
.sass-cache
.jekyll-metadata
Gemfile.lock
.code-workspace
17 changes: 17 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins

gem "tzinfo-data"
gem "wdm", "~> 0.1.0" if Gem.win_platform?

# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-paginate"
gem "jekyll-sitemap"
gem "jekyll-gist"
gem "jekyll-feed"
gem "jemoji"
gem "jekyll-include-cache"
gem "jekyll-algolia"
end
62 changes: 62 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 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 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
# 'bundle exec 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 }}.
title: Regolith
subtitle: Documentation
email: sirlich.business@gmail.com
description: >- # this means to ignore newlines until "baseurl:"
LOREM IPSUM
github_username: Bedrock-OSS
minimal_mistakes_skin: "plum" # "default", "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum" "sunrise"
search: true

# Build settings
markdown: kramdown
remote_theme: mmistakes/minimal-mistakes
# Outputting

include:
- _pages

# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
# exclude:
# - Gemfile
# - Gemfile.lock
# - node_modules
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/

# Plugins (previously gems:)
plugins:
- jekyll-paginate
- jekyll-sitemap
- jekyll-gist
- jekyll-feed
- jemoji
- jekyll-include-cache

logo: "/assets/images/logo.png"

defaults:
# _pages
- scope:
path: "_pages"
type: pages
values:
layout: single
58 changes: 58 additions & 0 deletions docs/_data/navigation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
main:
- title: "Home"
url: /
- title: "Documentation"
url: /documentation
- title: "Discord"
url: https://discord.gg/XjV87YN

sidebar:
- title: Getting Started
children:
- title: "Getting Started"
url: /documentation/getting_started
- title: "Running"
url: /documentation/running
- title: "Troubleshooting"
url: /documentation/troubleshooting

- title: Manual
children:
- title: "Templates"
url: /documentation/templates
- title: "Set-lang"
url: /documentation/setlang
- title: "Settings"
url: /documentation/settings
- title: "Single States"
url: /documentation/single_states
- title: "Transitions"
url: /documentation/transitions
- title: "Randomizers"
url: /documentation/randomizers

- title: Example
children:
- title: "Simple Example"
url: /documentation/examples/simple
- title: "Voice Examples"
url: /documentation/examples/voice
- title: "Without Dialogue"
url: /documentation/examples/no_dialogue
- title: "Using Custom Entities"
url: /documentation/examples/custom_entity
- title: "Multiple-State Entity"
url: /documentation/examples/multi_state
- title: "Trap Entity"
url: /documentation/examples/trap
- title: "Tutorial Entity"
url: /documentation/examples/tutorial_npc
- title: "Pathfinding"
url: /documentation/examples/pathfinding
- title: "Quest"
url: "/documentation/examples/quest"

- title: Schemas
children:
- title: "Template Schema"
url: /documentation/schemas/template
15 changes: 15 additions & 0 deletions docs/_pages/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Page Not Found"
excerpt: "Page not found. Wrong filter?"
sitemap: false
permalink: /404.html
---

Sorry, but the page you were trying to view does not exist --- perhaps you can try searching for it below.

<script>
var GOOG_FIXURL_LANG = 'en';
var GOOG_FIXURL_SITE = '{{ site.url }}'
</script>
<script src="https://linkhelp.clients.google.com/tbproxy/lh/wm/fixurl.js">
</script>
21 changes: 21 additions & 0 deletions docs/_pages/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
permalink: /documentation/
layout: single
sidebar:
nav: "sidebar"
feature_row:
- image_path: /assets/images/echo.png
alt: "Echo:NPC Logo: Bunny with Echo NPC text"
---

{% include feature_row id="feature_row" type="center" %}

# Documentation

Documentation pages are linked on the left hand side. If you are new to Echo:NPC, I suggest starting with the "Getting Started" section.

Experts might find browsing the "Examples" section interesting.

## Contributing

Got a cool example to share? Or perhaps spotted a bug/formatting mistake? Get in contact with me!
13 changes: 13 additions & 0 deletions docs/_pages/pricing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
permalink: /pricing/
layout: single
feature_row:
- image_path: /assets/images/echo.png
alt: "Echo:NPC Logo: Bunny with Echo NPC text"
---

{% include feature_row id="feature_row" type="center" %}

# Echo Availability

Echo:NPC is no longer available. Existing users can continue to use free of charge, but additional licenses are not being granted.
Binary file added docs/assets/images/echo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/echo_npc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/fast.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/favicon.ico
Binary file not shown.
Binary file added docs/assets/images/header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/header_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/powerful.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/simple.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Regolith"
layout: splash
permalink: /
intro:
- excerpt: 'Regolith: The Addon Compiler.'
- type: center
cards:
- image_path: assets/images/fast.png
alt: "Business Logic Icon: Clock and Paper"
title: "Blazingly Fast"
excerpt: "LOREM IPSUM"
url: "documentation/getting_started"
btn_class: "btn--primary"
btn_label: "Learn more"
- image_path: /assets/images/powerful.png
alt: "Business Logic Icon: Gear and Wrench"
title: "Powerful"
excerpt: "LOREM IPSUM"
url: "documentation/getting_started"
btn_class: "btn--primary"
btn_label: "Learn more"
- image_path: /assets/images/simple.png
alt: "Business Logic Icon: Cactus"
title: "Simple"
excerpt: "LOREM IPSUM"
url: "/documentation/examples/simple"
btn_class: "btn--primary"
btn_label: "Learn more"

testimonials:
- title: "SirLich"
excerpt: "LOREM IPSUM"
logo:
- image_path: /assets/images/echo.png
alt: "Echo:NPC Logo: Bunny with Echo NPC text"
excerpt: "LOREM IPSUM"
url: "/documentation/getting_started"
btn_label: "Get Started"
btn_class: "btn--primary"
---

{% include feature_row id="logo" type="center" %}

{% include feature_row id="cards"%}

<!-- # Built with Regolith
{: style="font-size: 200%; text-align: center;"}
{% include feature_row id="marketplace_maps"%} -->

# Testimonials
{: style="font-size: 200%; text-align: center;"}

{% include feature_row id="testimonials"%}

<!-- {% include video id="QpN7Wva5r20" provider="youtube" %} -->

<div>Icons made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>

0 comments on commit 75820c2

Please sign in to comment.