Skip to content

Commit 328509e

Browse files
change to mintlify
1 parent 4bd5504 commit 328509e

105 files changed

Lines changed: 1718 additions & 8576 deletions

File tree

Some content is hidden

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

.DS_Store

0 Bytes
Binary file not shown.

.github/workflows/mintlify.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Mintlify Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- mintlify
8+
pull_request:
9+
branches:
10+
- main
11+
- mintlify
12+
13+
jobs:
14+
validate:
15+
name: Validate Mintlify Config
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout code
20+
uses: actions/checkout@v4
21+
22+
- name: Setup Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: "18"
26+
27+
- name: Install Mintlify CLI
28+
run: npm install -g mintlify
29+
30+
- name: Validate mint.json
31+
run: |
32+
if [ -f mint.json ]; then
33+
echo "✅ mint.json found"
34+
# Basic validation - check if it's valid JSON
35+
node -e "JSON.parse(require('fs').readFileSync('mint.json', 'utf-8'))"
36+
echo "✅ mint.json is valid JSON"
37+
else
38+
echo "❌ mint.json not found"
39+
exit 1
40+
fi
41+
42+
- name: Check documentation files
43+
run: |
44+
echo "📚 Checking documentation files..."
45+
46+
# Check if docs directory exists
47+
if [ -d docs ]; then
48+
echo "✅ docs/ directory found"
49+
50+
# Count markdown files
51+
MD_COUNT=$(find docs -name "*.md" | wc -l)
52+
echo "📄 Found $MD_COUNT markdown files"
53+
54+
# Check if index.md exists
55+
if [ -f docs/index.md ]; then
56+
echo "✅ docs/index.md found"
57+
else
58+
echo "⚠️ docs/index.md not found - consider creating a homepage"
59+
fi
60+
else
61+
echo "❌ docs/ directory not found"
62+
exit 1
63+
fi
64+
65+
- name: Summary
66+
run: |
67+
echo "🎉 All checks passed!"
68+
echo "📖 Your Mintlify documentation is ready for deployment"
69+
echo ""
70+
echo "Next steps:"
71+
echo "1. Connect your repository to Mintlify at https://mintlify.com"
72+
echo "2. Your docs will be automatically deployed on every push"
73+
echo "3. Preview locally with: mintlify dev"

.gitignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# macOS
12
.DS_Store
23
docs/.DS_Store
34
site/.DS_Store
@@ -6,3 +7,18 @@ site/assets/javascripts/.DS_Store
67
site/linux-commands/.DS_Store
78
site/linux-software/.DS_Store
89
site/tools-customise/.DS_Store
10+
11+
# MkDocs
12+
site/
13+
14+
# Mintlify
15+
.mintlify/
16+
node_modules/
17+
.next/
18+
.cache/
19+
20+
# Logs
21+
*.log
22+
npm-debug.log*
23+
yarn-debug.log*
24+
yarn-error.log*

.mintlifyignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Ignore MkDocs configuration file
2+
mkdocs.yml
3+
4+
# Ignore any other MkDocs related files
5+
requirements.txt
6+
mkdocs_requirements.txt

0 commit comments

Comments
 (0)