🎉 init

Author: MelSardes

.github/workflows/deploy-docs.yml

@@ -0,0 +1,71 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/deploy-docs.yml'
+      - 'docs/**'
+      - 'blog/**'
+      - 'src/**'
+      - 'static/**'
+      - 'i18n/**'
+      - 'versioned_docs/**'
+      - 'versioned_sidebars/**'
+      - 'versions.json'
+      - 'sidebars.ts'
+      - 'docusaurus.config.ts'
+      - 'docusaurus.config.navigation.js'
+      - 'package.json'
+      - 'package-lock.json'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: package-lock.json
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Build website
+        run: npm run build
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,27 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# IDE
+.idea
+.vscode
+*.swp
+*.swo
+*~

.npmrc

@@ -0,0 +1,2 @@
+engine-strict=true
+legacy-peer-deps=false

README.md

@@ -0,0 +1,165 @@
+# Structus Documentation Website
+
+This directory contains the source code for the Structus documentation website, built with [Docusaurus 3](https://docusaurus.io/).
+
+## 🚀 Quick Start
+
+### Prerequisites
+
+- Node.js 18.0 or higher
+- npm 10.0 or higher
+
+### Installation
+
+```bash
+npm install
+```
+
+### Local Development
+
+```bash
+npm start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```bash
+npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Serve Built Site
+
+```bash
+npm run serve
+```
+
+This command serves the built website locally for testing.
+
+## 📁 Project Structure
+
+```
+.
+├── blog/                   # Blog posts
+│   ├── authors.yml        # Blog authors
+│   └── *.md               # Blog post files
+├── docs/                   # Documentation files
+│   ├── intro.md           # Introduction page
+│   ├── getting-started/   # Getting started guides
+│   ├── architecture/      # Architecture documentation
+│   ├── advanced/          # Advanced topics
+│   ├── best-practices/    # Best practices
+│   └── reference/         # API reference
+├── src/
+│   ├── components/        # React components
+│   ├── css/              # Custom CSS
+│   └── pages/            # Custom pages (homepage, etc.)
+├── static/
+│   └── img/              # Static images
+├── docusaurus.config.ts   # Docusaurus configuration
+├── sidebars.ts           # Sidebar configuration
+├── package.json          # Dependencies
+└── tsconfig.json         # TypeScript configuration
+```
+
+## 🎨 Customization
+
+### Theme Colors
+
+Edit `src/css/custom.css` to customize the color scheme. The current theme uses a purple/indigo palette inspired by detekt.dev.
+
+### Homepage
+
+Edit `src/pages/index.tsx` to customize the homepage content and layout.
+
+### Navigation
+
+Edit `docusaurus.config.ts` to modify the navbar and footer links.
+
+### Sidebar
+
+Edit `sidebars.ts` to organize the documentation structure.
+
+## 📝 Writing Documentation
+
+### Creating a New Doc
+
+1. Create a new `.md` file in the appropriate `docs/` subdirectory
+2. Add frontmatter at the top:
+
+```markdown
+---
+sidebar_position: 1
+title: Your Title
+---
+
+# Your Content
+```
+
+3. The file will automatically appear in the sidebar based on the directory structure
+
+### Adding a Blog Post
+
+1. Create a new `.md` file in `blog/` with the format `YYYY-MM-DD-slug.md`
+2. Add frontmatter:
+
+```markdown
+---
+slug: your-slug
+title: Your Title
+authors: [melsardes]
+tags: [tag1, tag2]
+---
+
+Your content here
+
+<!-- truncate -->
+
+More content after the fold
+```
+
+## 🚢 Deployment
+
+### GitHub Pages
+
+The site can be deployed to GitHub Pages using:
+
+```bash
+npm run deploy
+```
+
+Make sure to configure the `organizationName`, `projectName`, and `url` in `docusaurus.config.ts`.
+
+### Other Platforms
+
+The built site in the `build/` directory can be deployed to:
+- Netlify
+- Vercel
+- AWS S3
+- Any static hosting service
+
+## 📚 Resources
+
+- [Docusaurus Documentation](https://docusaurus.io/)
+- [Markdown Features](https://docusaurus.io/docs/markdown-features)
+- [Styling and Layout](https://docusaurus.io/docs/styling-layout)
+
+## 🤝 Contributing
+
+Contributions to the documentation are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+## 👨‍💻 Creator
+
+**Structus** was created by [Mel Sardes](https://github.com/melsardes).
+
+## 📄 License
+
+This documentation is part of the Structus project and is licensed under the MIT License.