Skip to content

Commit bc9e9a0

Browse files
committed
docs(structure): remove GitBook, keep Docusaurus only 📚
1 parent 0a37e4a commit bc9e9a0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2673
-3839
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main, master]
6+
paths: ['docs/**']
7+
8+
# Allow manual trigger
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: false
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
30+
- name: Setup Node.js
31+
uses: actions/setup-node@v4
32+
with:
33+
node-version: 18
34+
cache: npm
35+
cache-dependency-path: docs/package-lock.json
36+
37+
- name: Setup Pages
38+
uses: actions/configure-pages@v4
39+
40+
- name: Install dependencies
41+
run: cd docs && npm ci
42+
43+
- name: Build documentation
44+
run: cd docs && npm run build
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v2
48+
with:
49+
path: ./docs/build
50+
51+
deploy:
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
runs-on: ubuntu-latest
56+
needs: build
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v3

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
AI-powered git commit message generator that works completely offline. Analyzes your staged changes and generates meaningful commit messages following the format: `type(action): description`.
44

5+
📚 **[Complete Documentation →](https://neadigitra.github.io/Git-Smart/)**
6+
57
## Features
68

79
- 🤖 **Intelligent Analysis**: Analyzes code changes, file types, and patterns
@@ -70,7 +72,7 @@ Options:
7072
-i, --interactive Interactive mode with multiple suggestions
7173
-v, --verbose Show detailed analysis information
7274
-d, --dry-run Show suggested message without committing
73-
-h, --help Show help message
75+
-h, --help Show help message
7476
```
7577

7678
Or if installed globally:

docs/.gitignore

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*
21+
22+
# IDE
23+
.vscode/
24+
.idea/
25+
*.swp
26+
*.swo
27+
28+
# OS
29+
Thumbs.db

docs/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Git-Smart Documentation
2+
3+
This directory contains the Docusaurus-based documentation for Git-Smart.
4+
5+
## Quick Start
6+
7+
```bash
8+
# Install dependencies
9+
npm install
10+
11+
# Start development server
12+
npm start
13+
14+
# Build for production
15+
npm run build
16+
```
17+
18+
## Structure
19+
20+
- `/docs` - Documentation content (Markdown files)
21+
- `/src` - Custom React components and pages
22+
- `/static` - Static assets (images, files)
23+
- `/docusaurus.config.js` - Main configuration file
24+
25+
## Deployment
26+
27+
The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.
28+
29+
### Manual Deployment
30+
31+
```bash
32+
# Deploy to GitHub Pages
33+
GIT_USER=your-username npm run deploy
34+
```
35+
36+
## Contributing
37+
38+
1. Edit documentation files in the `/docs` directory
39+
2. Test changes locally with `npm start`
40+
3. Submit a pull request
41+
42+
## Configuration
43+
44+
Key configuration files:
45+
46+
- `docusaurus.config.js` - Main Docusaurus configuration
47+
- `sidebars.js` - Sidebar navigation structure
48+
- `src/css/custom.css` - Custom styling
49+
50+
## Features
51+
52+
- ✅ Responsive design
53+
- ✅ Dark/light mode
54+
- ✅ Search integration (Algolia)
55+
- ✅ Code syntax highlighting
56+
- ✅ Mobile-friendly navigation
57+
- ✅ SEO optimization
58+
- ✅ Social media cards
59+
60+
## Links
61+
62+
- [Documentation Site](https://neabyte.github.io/git-smart/)
63+
- [Docusaurus Documentation](https://docusaurus.io/)
64+
- [Main Git-Smart Repository](https://github.com/NeaDigitra/git-smart)

0 commit comments

Comments
 (0)