Skip to main content
Version: 1.0

📋 The Installation-Script

This manual is auto-generated from modular script design.

🏗 Step: vars​

Initializing global environment and defining project constants.

Result:
Global state initialized. Variable registry ready for injection.

🏗 Step: help​

📖 Manual Access: Generating the technical manifest from modular components.

Result:
Returning to main installer flow.

🏗 Step: intro​

🚀 Starting the Kickstart Engine: Verifying local environment and Node.js prerequisites.

Result:
Environment verified. Prerequisite check passed.

🏗 Step: backup​

🛡️ Safety-First Protection​

Before we modify your project, we recommend creating a recovery point.

  • Archive: Creates a timestamped .tar.gz (best for existing projects).
  • Selective: Backs up only the specific config files we patch.
  • Skip: Only recommended for clean, empty repositories.

⚖️ Disclaimer & Responsibility​

By using static-repo-page-kickstart, you acknowledge and agree to the following terms:

  1. User Responsibility The user assumes full and sole responsibility for any actions performed by this script. While the tool is designed to be helpful and non-destructive, the final execution and its consequences reside entirely with the operator.

  2. Mandatory Audit (Verify Before Use) You are strongly advised to inspect the script source code before execution. Use the following command to audit the logic:

    curl -sSL https://gitlab.com/vvdb/static-repo-page-kickstart/-/raw/main/setup.sh?ref_type=heads | less

    Alternatively you can see the script directly by calling the URL in the browser:

    https://gitlab.com/vvdb/static-repo-page-kickstart/-/raw/main/setup.sh?ref_type=heads.

    Never run code from the internet without understanding its impact on your specific environment.

  3. Mandatory Backup A full, manual backup of your entire repository should be performed before any action is taken. While the script provides an automated tar.gz backup option (as part of the Safety-First pillar), this should be considered a secondary safety net. Your primary protection is a manual, verified copy of your data.

  4. Limitation of Liability The author(s) of this script cannot and will not be held responsible for any kind of damage, data loss, downtime, or repository corruption resulting from the use or misuse of this software. This tool is provided "as is," without warranty of any kind, express or implied.

  5. Report any kind of issues There might be several reasons to give feedback about the script or the whole project, you're welcome to post any issues, feature requests or improvements on: the issue page

Result:
🛡️ Safety Net Created: Backups stored with unique timestamps. You can roll back if needed.

🏗 Step: safety​

🔍 Collision Detection​

We are scanning your root directory for existing website/ folders or CI/CD files (.gitlab-ci.yml).

  • If detected, choosing Purge will delete existing data to ensure a clean Docusaurus install.
  • Choosing Overwrite will attempt to merge the new framework into your current structure.

Result:
Collision check complete. The path is clear for installation.

🏗 Step: scaffold​

🏗️ Framework Selection​

Select the core 'Center-Stone' for your site.

  • TypeScript (TS): Recommended for better maintainability and error checking.
  • JavaScript (JS): Standard choice for rapid prototyping. This step pulls the official Docusaurus 'classic' template.

Result:
🏗️ Core Installed: Framework in place. Modular components ready for configuration.

🏗 Step: git_config​

📦 Git Optimization​

To maintain Standardization, we are moving Docusaurus-specific ignore rules to your root .gitignore. This ensures your repository remains clean and that build artifacts are never accidentally committed.

Result:
📦 Standardized Ignore: Git rules are now synchronized between your code and your website.

🏗 Step: prompts​

📝 Repository Metadata​

Please enter your project details:

  • GitHub Username: The owner of the target GitHub Pages site.
  • Repository Name: This must match your GitHub project name for the URL paths to work correctly (e.g., https://user.github.io).

Result:
Configuration locked. Sanitizing inputs for configuration patching.

🏗 Step: patching​

⚙️ Configuration Patching​

We are now injecting your metadata into docusaurus.config.ts.

  • We will automatically update the url, baseUrl, and organizationName.
  • Your site title and tagline will be set based on your previous inputs.

Result:
⚙️ Config Patched: docusaurus.config.ts updated with your specific URLs.

🏗 Step: versioning​

🔢 Versioned Documentation​

We will lock the current content as your first 'Stable' version. This allows you to continue developing new features in the main branch without breaking existing user guides.

🏗 Step: edit_urls​

🔗 Edit Link Configuration​

We are now setting the 'Edit this page' links to point directly to your repository. This allows contributors to submit changes to your documentation and blog posts with a single click.

🏗 Step: workflows​

🌉 Choose Your Bridge​

Select how you want to deploy your documentation:

  1. GitLab ➡️ GitHub: Keep your source on GitLab and deploy to GitHub Pages (Cross-Platform).
  2. Pure GitHub: Uses GitHub Actions for native deployment.
  3. Pure GitLab: Uses GitLab Pages for internal hosting.

Result:
🌉 Bridge Configured: CI/CD templates injected. Check 'workflow-guide.md' for activation steps.

🏗 Step: cleanup​

🧹 Final Polish: Removing temporary artifacts and preparing the repository for the first commit.

Result:
✨ Kickstart Successful: Your professional documentation hub is ready.

🏗 Step: contributor_guide​

Result:
Created Contributor Guide in website/docs/documentation/contributing.md