Skip to content

Commit

Permalink
ci(_config.yml): simplify and update Jekyll configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
cyril committed Jan 1, 2025
1 parent 27890cb commit 4d97ee7
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 110 deletions.
29 changes: 3 additions & 26 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
title: "Fix: Happy Path to Ruby Testing"
author:
name: Cyril Kato
url: "https://github.com/cyril"

description: >
Fix is a modern Ruby testing framework built around a key architectural principle:
the complete separation between specifications and tests. It allows you to write
Expand All @@ -13,36 +11,15 @@ remote_theme: jekyll/minima
plugins:
- jekyll-feed
- jekyll-remote-theme
- jekyll-sitemap
- jekyll-seo-tag

minima:
skin: auto
social_links:
- { platform: github, user_url: "https://github.com/fixrb/fix" }
- { platform: x, user_url: "https://x.com/fix_rb" }
- { platform: bsky, user_url: "https://bsky.app/profile/fixrb.dev" }
- { platform: rss, user_url: "/feed.xml" }
- { platform: github, user_url: "https://github.com/fixrb/fix" }
- { platform: x, user_url: "https://x.com/fix_rb" }
- { platform: bsky, user_url: "https://bsky.app/profile/fixrb.dev" }

# Feed configuration
feed:
icon: /favicon.png
logo: /favicon.png
posts_limit: 100

# SEO
twitter:
username: fix_rb
card: summary

social:
name: Fix Framework
links:
- https://github.com/fixrb/fix
- https://x.com/fix_rb
- https://bsky.app/profile/fixrb.dev

# GitHub Pages specific
github:
is_project_page: true
repository_url: "https://github.com/fixrb/fix"
33 changes: 18 additions & 15 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,36 @@
<data class="u-url" href="{{ "/" | relative_url }}"></data>

<div class="wrapper">

<div class="footer-col-wrapper">
<div class="footer-col">
<h2 class="footer-heading">Resources</h2>
<p class="feed-subscribe">
<a href="{{ site.feed.path | default: 'feed.xml' | absolute_url }}">
<svg class="svg-icon orange">
<use xlink:href="{{ 'assets/minima-social-icons.svg#rss' | relative_url }}"></use>
</svg><span>Subscribe</span>
</a>
</p>
{%- if site.author %}
<ul class="contact-list">
<li><a href="https://rubydoc.info/gems/fix">Documentation</a></li>
<li><a href="https://github.com/fixrb/fix">GitHub</a></li>
<li><a href="/about/">About</a></li>
<li class="feed-subscribe">
<a href="{{ site.feed.path | default: 'feed.xml' | absolute_url }}">
<svg class="svg-icon orange">
<use xlink:href="{{ 'assets/minima-social-icons.svg#rss' | relative_url }}"></use>
</svg><span>Subscribe</span>
</a>
</li>
{% if site.author.name -%}
<li class="p-name">{{ site.author.name | escape }}</li>
{% endif -%}
{% if site.author.email -%}
<li><a class="u-email" href="mailto:{{ site.author.email }}">{{ site.author.email }}</a></li>
{%- endif %}
</ul>
{%- endif %}
</div>

<div class="footer-col">
<p>{{ site.description | escape }}</p>
{%- if site.author %}
<p class="p-name">Created by <a href="{{ site.author.url }}">{{ site.author.name | escape }}</a></p>
{%- endif %}
</div>
</div>

<div class="social-links">
{%- include social.html -%}
</div>

</div>

</footer>
23 changes: 0 additions & 23 deletions docs/about.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,46 +0,0 @@
---
layout: home
title: "Fix: Happy Path to Ruby Testing"
---

## Modern Ruby Testing Framework

Fix is a modern Ruby testing framework that emphasizes clear separation between specifications and examples. Unlike traditional testing frameworks, Fix focuses on creating pure specification documents that define expected behaviors without mixing in implementation details.

### Getting Started

Add to your Gemfile:

```ruby
gem "fix"
```

Or install it yourself:

```sh
gem install fix
```

### Key Features

- **Pure Specifications**: Write specification documents that focus solely on defining behaviors
- **Semantic Precision**: Use MUST, SHOULD, and MAY to clearly define requirement levels
- **Clear Separation**: Keep specifications and implementations separate for better maintainability
- **Fast Execution**: Run tests quickly and independently
- **Rich Matcher Library**: Comprehensive set of matchers for different testing needs

### Quick Example

```ruby
# Define your specification
Fix :Calculator do
on(:add, 2, 3) do
it MUST eq 5
end
end

# Test your implementation
Fix[:Calculator].test { Calculator }
```

Discover more about Fix in our [documentation](https://rubydoc.info/gems/fix) or check our [source code](https://github.com/fixrb/fix).

0 comments on commit 4d97ee7

Please sign in to comment.