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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
29 changes: 27 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
# .gitignore for Jekyll websites

# Site output
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata
# Ignore folders generated by Bundler

# Dependencies
node_modules/
.bundle/
vendor/
# vendor/
vendor/bundle/
vendor/cache/
vendor/gems/
vendor/ruby/

# Gem lock
Gemfile.lock

# Log files
*.log

# OS generated files
.DS_Store
Thumbs.db

# dotenv environment variables
.env

# Byebug command history
.byebug_history
18 changes: 18 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default
description: Sorry – the page your looking for doesn't exist.
permalink: /404.html
---

<div class="page-header error-page fullWidth">
<div class="page-header-image" style="background-image: url('{{ '/assets/img/ill/404.svg' | relative_url }}')"></div>
<div class="container">
<div class="row">
<div class="col-md-12 text-center">
<h1 class="title">404</h1>
<p class="lead">Page not found :(</p>
<h4 class="description text-default">Ooooups! Looks like you got lost.</h4>
</div>
</div>
</div>
</div>
10 changes: 10 additions & 0 deletions 500.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: default
description: Sorry – the page your looking for doesn't exist.
permalink: /500.html
---
<div class="error-page">
<div class="page-header page-500 fullWidth">
<div class="page-header-image" style="background-image: url('{{ '/assets/img/ill/500.svg' | relative_url }}')"></div>
</div>
</div>
12 changes: 12 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
source 'https://rubygems.org'

gem "github-pages", "~> 232", group: :jekyll_plugins

#gem 'jekyll'#, "~> 3.10.0"

group :jekyll_plugins do
gem 'jekyll-paginate'
gem 'jekyll-sitemap'
end
gem "webrick"

15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
# FormingWorlds.github.io
# proteus-framework.org

## How to edit the page

Explanations for deployment and local testing are here:
https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll

The order of making changes to the website is as follows:
- Create a new branch
- Add the feature or fix
- Create a pull request
- Upon acceptance the website will be updated automatically


45 changes: 45 additions & 0 deletions _LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Argon by JekyllThemes.io – License

This license grants you, the purchaser, an ongoing, non-exclusive, worldwide license to make use of the theme. Read the rest of this license for the details that apply to your use of the theme.

---

## Using the theme

You are licensed to use the theme to create one single End Product for yourself or for one client (a “single application”), and the End Product can be distributed for Free.

The End Product is a customised implementation of the theme. For example: the end product is the final website customised with your content.

---

## What you CAN do with the theme

You can create one End Product for a client, and you can transfer that single End Product to your client for any fee. This license is then transferred to your client.

You can make any number of copies of the single End Product, as long as the End Product is distributed for Free.

You can modify or manipulate the theme. You can combine the theme with other works and make a derivative work from it. The resulting works are subject to the terms of this license.

---

## What you CAN'T do with the theme

You can’t Sell the End Product, except to one client. (If you or your client want to Sell the End Product, you will need an Extended License – send an email to hello@jekyllthemes.io to discuss this with us.)

You can’t re-distribute the theme as stock, in a tool or template, or with source files. You can’t do this with the theme either on its own or bundled with others, and even if you modify the theme. You can’t re-distribute or make available the theme as-is or with superficial modifications. These things are not allowed even if the re-distribution is for Free.

For example: You can’t purchase the theme, convert it to a WordPress theme and sell or give it to more than one client. You can’t license the theme and then make it available as-is on your website for your users to download.

You can’t use the theme in any application allowing an end user to customise a digital or physical product to their specific needs, such as an “on demand”, “made to order” or “build it yourself” application. You can use the theme in this way only if you purchase a separate license for each final product incorporating the theme that is created using the application.

---

## Other license terms

Some components of the theme are sourced by the author from elsewhere and different license terms may apply to the component, such as someone else’s license or an open source or creative commons license. The other license will apply to that component instead of this license. This license will apply to the rest of the theme.

You can only use the theme for lawful purposes.

This license can be terminated if you breach it. If that happens, you must stop making copies of or distributing the End Product until you remove the theme from it.

JekyllThemes.io retains ownership of the theme, but grants you the license on these terms.
158 changes: 158 additions & 0 deletions _README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# Argon Pro for Jekyll - Instructions

This theme is a collaboration between [Creative Tim](https://creative-tim.com) and [Jekyll Themes](https://jekyllthemes.io).

This readme file covers all of the **Jekyll-specific features** only. If you need help with using the Argon design system itself, you should visit the [documentation page](https://demos.creative-tim.com/argon-design-system/docs/getting-started/overview.html) or [contact the Creative Tim team](https://www.creative-tim.com/contact-us) for support.

---

## Getting Started

Copy the theme files to your website directory.

To run the theme locally, navigate to the theme directory in your terminal and run `bundle install` to install the theme's dependencies. Then run `jekyll serve` to start the Jekyll server.

If you're not familiar with how Jekyll works, check out [jekyllrb.com](https://jekyllrb.com/) for all the details, or read up on just the basics of [front matter](https://jekyllrb.com/docs/frontmatter/), [writing posts](https://jekyllrb.com/docs/posts/), and [creating pages](https://jekyllrb.com/docs/pages/).

---

## Customizing the theme

This theme can be adapted to suit your needs...

### The `_config.yml` file

You'll need to change:

- site: Change this to your website's name
- url: The full URL that your site will be hosted at, e.g. https://your-domain.com
- baseurl: Add a base URL here if you will be publishing the site inside a folder, e.g. https://your-domain.com/project/ – or if you're hosting it as a 'project page' on GitHub Pages. Example: `baseurl: /project`
- paginate: Change this to set the number of blog posts on each page. If you are using the blog grid styles, this is best in multiples of 3.

When using baseurl, you should reference images in your post/project Frontmatter **without** the baseurl, e.g. `/images/image.jpg` but images inside the Markdown content **should include** the baseurl snippet, e.g. `{{site.baseurl}}/images/image.jpg`

You can also change more advanced things here like the path names, collections etc. You do not need to change any of these to achieve the same look as the demo, so best to leave everything else unless you are confident.

### The `settings.yml` file

You'll find this inside the `_data` folder – this is where you can set all of the theme options.

**Basic settings**

`site_title` – change this to your website's title. This shows up in the browser's title bar, and in the header and footer.
`favicon_image` – change this to the location of your favicon image, which shows up in the browser's title bar.

**Header settings**

`logo_image` – if you'd like to use a logo instead of plain text title in your header, enter the link to it here.
`theme` – choose a color for your header [blue, dark, light]

**Blog settings**

`theme` – choose a format for your blog listings [basic, narrow, grid]
`read_more` – display a narrow grid of other blog posts after each blog [yes, no]

**Menu settings**

This allows you to set the links inside your menu. Add each one as a list item with a `title` and `url`. When hosting on GitHub Pages, make sure you leave a trailing `/` at the end of links to category pages (e.g. `/blog/` or `/projects/`).

**Footer settings**

`footer_tagline` – sets the text that displays on the left hand side of the footer.

**Contact settings**

The theme comes with a pre-made contact form that you can use with [Formspree](https://formspree.io/create/jekyllthemes), which is free for up to 50 submissions per month. They also have two great paid plans that offer advanced features. Use the link above to set up your account and then paste the 'endpoint' integration code into the theme settings:

`form_action` – this is the form endpoint attribute that you get from FormSpree, for example `https://formspree.io/abcdefgh`
`confirmation_url` – by default the user is shown a default Formspree thank you page. If you have a premium plan, you can use this setting to provide an alternative URL for that page, for example `/thanks` – we have included a basic thank you page with the theme.
`email_subject` – choose the subject of the email you receive from Formspree.
`send_button_text` – change the text used on the form submit button.

Hint: you can add the contact form to any page of your site using the include – `{% include contact-form.html %}` – for example if you wanted to have the contact form on your About page.

**Social settings**

Here you can add links to your profiles on social networks, and they'll be shown in the footer. Simply add your URL next to the ones you want to show.

**Author settings**

If you are using the basic blog theme, you can add display author information in the list of posts.

Make sure the name of the author of the post matches the author name field exactly in settings.yml.

**Advanced options**

`analytics_code` – use this option to add your Google Analytics code.
`header_js` – use this option to insert javascript into the header of the page.
`footer_js` – use this option to insert javascript at the end of the page.

---

### Images

Inside the `/assets/img/` folder you'll find a few images included with the theme.

`favicon.png` – you should replace this with the favicon image you'd like to use for your website.

---

## Main pages

The theme comes with some pages set up ready for your content.

#### Home – `/index.html`

This is your website home page. You can edit some details in the Front Matter at the top of the page:

- `title` – this sets the page title, which shows up in the browser's title bar and on search engine results, social shares etc.
- `description` – this sets the page meta description, which shows up on search engine results, social shares etc.
- `featured_image` – this sets the header image for the page, as well as the meta image, which shows up on social shares.

Below the Front Matter is the code for the page. We've included an example, but you can replace this with your own text content written in markdown.

If you want to add some pre-made sections, such as a pricing table, carousel of team members, or an accordion, following the steps below:

1. Find the component you like in `_includes/component`
2. Add it to index.html by typing `{% include components/pricing/pricing-1.html %}` replacing `/pricing/pricing-1.html` with your desired component

#### Blog – `/blog/index.html`

This is the blog listing page, which shows all your blog posts. You can edit the same things as on the home page to customise it for your website.

#### Sample Content and Other Pages

We have included some example pages in `_pages` to help you get started and easily see how the included components are displayed.

You may delete them or modify them to suit your needs. You can edit some details in the Front Matter at the top of the page:

- `title` – this sets the page title, which shows up in the browser's title bar and on search engine results, social shares etc.
- `subtitle` – this sets the page title, which displays below the title in the header
- `description` – this sets the page meta description, which shows up on search engine results, social shares etc.
- `featured_image` – this sets the header image for the page, as well as the meta image, which shows up on social shares.
- `layout` – this sets the layout for the page. You can choose from page-heading, no-page-heading or page. Page-heading shows a banner, no-page-header has no heading at all and page has a simple text heading.

Below the Front Matter is the code for the page. We've included all of the components built into the theme as an example, but you can replace this with your own text content written in markdown.

If you want to add some pre-made sections, such as a pricing table, carousel of team members, or an accordion, following the steps below:

1. Find the component you like in `_includes/component`
2. Add it to index.html by typing `{% include components/pricing/pricing-1.html %}` replacing `/pricing/pricing-1.html` with your desired component

#### Modify components with your content

If you want to modify these components, we recommend the workflow below:

1. Find the component you like in `_includes/component`
2. Duplicate it and rename it
3. Add it to your page by typing `{% include components/pricing/pricing-1.html %}` replacing `/pricing/pricing-1.html` with your renamed component


## Any questions?

If you need help with using the **Argon design system itself**, you should visit the [documentation page](https://demos.creative-tim.com/argon-design-system/docs/getting-started/overview.html) or [contact the Creative Tim team](https://www.creative-tim.com/contact-us) for support.

If you have any questions or feedback about the **Jekyll features** of the theme, don't hesitate to reach out to hello@jekyllthemes.io for 1-to-1 support direct from the developers!

🤘

49 changes: 49 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll?platform=linux
# https://pages.github.com/versions/

site: PROTEUS Framework
domain: formingworlds.github.io

url: https://proteus-framework.org
baseurl:

collections:
pages:
output: true
permalink: /:name
posts:
output: true
permalink: /blog/:slug
type: "post"

defaults:
-
scope:
path: ""
values:
layout: "default"
-
scope:
path: ""
type: "pages"
values:
layout: "default"
-
scope:
path: ""
type: "posts"
values:
layout: "post"

sass:
sass_dir: assets/styles
style: compressed
sourcemap: never

plugins:
- jekyll-paginate
- jekyll-sitemap

paginate: 6
paginate_path: "/blog/page:num/"

Loading