Skip to content

Commit 9ec3bb4

Browse files
committed
fix: simplify Just the Docs configuration for GitHub Pages compatibility
1 parent 88d05d3 commit 9ec3bb4

3 files changed

Lines changed: 17 additions & 65 deletions

File tree

docs/Gemfile

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
source "https://rubygems.org"
22

3-
gem "jekyll", "~> 4.3.0"
4-
gem "just-the-docs"
3+
gem "jekyll", "~> 4.4.1"
4+
gem "just-the-docs", "0.10.1"
55

66
# Jekyll plugins
77
gem "jekyll-seo-tag"
8-
gem "jekyll-sitemap"
9-
gem "jekyll-feed"
108

119
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
1210
# and associated library.
@@ -20,4 +18,4 @@ gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
2018

2119
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
2220
# do not have a Java counterpart.
23-
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
21+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

docs/_config.yml

Lines changed: 3 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,40 @@
11
# AI Command Auditor Documentation Site
22
title: "AI Command Auditor"
33
description: "Secure command validation and analysis for development workflows"
4+
theme: just-the-docs
5+
46
url: "https://etherisc.github.io"
57
baseurl: "/ai-command-auditor"
68

7-
# Theme
8-
remote_theme: just-the-docs/just-the-docs
9-
109
# Color scheme
1110
color_scheme: light
1211

13-
# Logo and favicon
14-
logo: "/assets/images/logo.png"
15-
1612
# Search
1713
search_enabled: true
18-
search:
19-
heading_level: 2
20-
previews: 3
21-
preview_words_before: 5
22-
preview_words_after: 10
23-
tokenizer_separator: /[\s/]+/
24-
rel_url: true
25-
button: false
26-
27-
# Navigation
28-
nav_sort: case_insensitive
2914

3015
# Aux links (top right)
3116
aux_links:
3217
"GitHub Repository":
3318
- "https://github.com/etherisc/ai-command-auditor"
34-
"Quick Install":
35-
- "/installation"
3619

3720
aux_links_new_tab: true
3821

39-
# Footer
22+
# Footer content
4023
footer_content: "Copyright &copy; 2024 Etherisc. Distributed under the <a href=\"https://github.com/etherisc/ai-command-auditor/blob/main/LICENSE\">MIT License</a>."
4124

4225
# Back to top link
4326
back_to_top: true
44-
back_to_top_text: "Back to top"
45-
46-
# Last edit timestamp
47-
last_edit_timestamp: true
48-
last_edit_time_format: "%b %e %Y at %I:%M %p"
4927

5028
# Git repository info
5129
gh_edit_link: true
5230
gh_edit_link_text: "Edit this page on GitHub"
5331
gh_edit_repository: "https://github.com/etherisc/ai-command-auditor"
5432
gh_edit_branch: "main"
5533
gh_edit_source: docs
56-
gh_edit_view_mode: "tree"
57-
58-
# Callouts
59-
callouts_level: quiet
60-
callouts:
61-
highlight:
62-
color: yellow
63-
new:
64-
title: New
65-
color: green
66-
note:
67-
title: Note
68-
color: blue
69-
warning:
70-
title: Warning
71-
color: red
72-
73-
# Mermaid diagrams
74-
mermaid:
75-
version: "9.1.3"
7634

7735
# Plugins
7836
plugins:
7937
- jekyll-seo-tag
80-
- jekyll-sitemap
81-
- jekyll-feed
82-
83-
# SEO
84-
author:
85-
name: "Etherisc"
86-
url: "https://github.com/etherisc"
87-
88-
social:
89-
name: Etherisc
90-
links:
91-
- https://github.com/etherisc
9238

9339
# Exclude from processing
9440
exclude:
@@ -105,4 +51,3 @@ exclude:
10551
- bin/
10652
- README.md
10753
- Rakefile
108-
- docs/tests/

docs/index.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2-
layout: default
2+
layout: home
33
title: Home
44
nav_order: 1
55
description: "AI Command Auditor - Secure command validation and analysis for development workflows"
66
permalink: /
77
---
88

99
# AI Command Auditor
10+
1011
{: .fs-9 }
1112

1213
Secure command validation and analysis for development workflows
@@ -24,7 +25,7 @@ AI Command Auditor is a powerful tool that validates and analyzes commands in yo
2425
### Key Features
2526

2627
- **🛡️ Intelligent Security Analysis**: AI-powered command validation to detect dangerous patterns
27-
- **⚙️ Customizable Rules**: Flexible security rules and validation patterns
28+
- **⚙️ Customizable Rules**: Flexible security rules and validation patterns
2829
- **🔗 Git Integration**: Seamless git hooks for automatic command validation
2930
- **📝 AI-Powered Prompts**: Customizable AI prompts for context-aware analysis
3031
- **🎨 Template System**: Pre-configured templates for different project types
@@ -54,22 +55,26 @@ ai-auditor --version
5455
## 🎬 Quick Start Tutorial
5556

5657
1. **Install AI Command Auditor**
58+
5759
```bash
5860
curl -fsSL https://raw.githubusercontent.com/etherisc/ai-command-auditor/main/install.sh | sh
5961
```
6062

6163
2. **Test Your First Command**
64+
6265
```bash
6366
ai-auditor check-command "rm -rf temp/"
6467
```
6568

6669
3. **Customize Configuration**
70+
6771
```bash
6872
# Edit security rules
6973
nano .ai-auditor/config/rules/security-rules.yml
7074
```
7175

7276
4. **Setup Git Hooks**
77+
7378
```bash
7479
ai-auditor setup-hooks
7580
```
@@ -79,15 +84,19 @@ ai-auditor --version
7984
## 🌟 Why Choose AI Command Auditor?
8085

8186
### Intelligent & Adaptive
87+
8288
Our AI-powered analysis goes beyond simple pattern matching to understand context and intent, providing smarter security decisions.
8389

8490
### Developer-Friendly
91+
8592
Designed by developers for developers, with intuitive configuration, clear documentation, and minimal setup friction.
8693

8794
### Enterprise-Ready
95+
8896
Scalable configuration management, audit logging, and team collaboration features for organizations of any size.
8997

9098
### Open Source
99+
91100
Fully open source with active community development, transparent security practices, and extensible architecture.
92101

93102
---

0 commit comments

Comments
 (0)