TheSecretJuice

TheSecretJuice Documentation Website

This is the official documentation website for TheSecretJuice - PowerShell steroids for CLI tools.

📁 Structure

docs/
├── index.html              # Homepage
├── modules.html            # Module browser
├── module.html             # Dynamic module detail page
├── installation.html       # Installation guide
├── contribute.html         # Contribution guidelines
├── changelog.html          # Version history and roadmap
├── assets/
│   ├── css/
│   │   ├── main.css       # Core styles and variables
│   │   ├── components.css # Component-specific styles
│   │   └── scrollbar.css  # Custom scrollbar
│   ├── js/
│   │   └── app.js         # Main application logic
│   └── data/
│       └── modules.json   # Module metadata
└── README.md              # This file

🎨 Design System

Colors

Components

🚀 Features

🛠️ Local Development

Simply open any HTML file in your browser:

# Open homepage
open index.html

# Or start a local server
python -m http.server 8000
# Then visit http://localhost:8000

📝 Adding New Modules

To add a new module to the documentation:

  1. Update assets/data/modules.json:
    {
      "name": "new-tool-enhance",
      "description": "Description of what it does",
      "path": "Steroids/new-tool-enhance.ps1",
      "category": "Category Name",
      "keywords": ["keyword1", "keyword2"],
      "icon": "fa-icon-name",
      "commands": ["command1", "command2"],
      "features": ["Feature 1", "Feature 2"]
    }
    
  2. Create a markdown file: new-tool-enhance.md

  3. Module will automatically appear on the website!

🌐 GitHub Pages Deployment

This site is designed for zero-config deployment to GitHub Pages:

  1. Push to main branch
  2. Enable GitHub Pages in repository settings
  3. Set source to /docs folder
  4. Done! Site will be live at https://username.github.io/TheSecretJuice/

🎯 Technologies Used

📄 License

MIT License - Same as the main project

🤝 Contributing

To improve the documentation:

  1. Edit HTML/CSS/JS files
  2. Update modules.json for module changes
  3. Test locally before committing
  4. Submit a PR with clear description

Built with ❤️ by mini-page