Skip to content

Commit 444260b

Browse files
SmilefounderSmilefounder
committed
upd
1 parent 24fc8c2 commit 444260b

File tree

18 files changed

+1561
-160
lines changed

18 files changed

+1561
-160
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- 'docs/**'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
name: Build website
23+
runs-on: ubuntu-latest
24+
defaults:
25+
run:
26+
working-directory: ./docs
27+
steps:
28+
- name: Checkout repository
29+
uses: actions/checkout@v4
30+
31+
- name: Setup Node.js
32+
uses: actions/setup-node@v4
33+
with:
34+
node-version: 18
35+
cache: npm
36+
cache-dependency-path: ./docs/package-lock.json
37+
38+
- name: Setup Pages
39+
id: pages
40+
uses: actions/configure-pages@v4
41+
42+
- name: Install dependencies
43+
run: npm ci
44+
45+
- name: Build website
46+
run: npm run build
47+
env:
48+
BASE_URL: ${{ steps.pages.outputs.base_path }}
49+
50+
- name: Add CNAME file if exists
51+
run: |
52+
if [ -f "CNAME" ]; then
53+
cp CNAME build/
54+
fi
55+
56+
- name: Upload artifact
57+
uses: actions/upload-pages-artifact@v3
58+
with:
59+
path: ./docs/build
60+
61+
deploy:
62+
name: Deploy to GitHub Pages
63+
environment:
64+
name: github-pages
65+
url: ${{ steps.deployment.outputs.page_url }}
66+
runs-on: ubuntu-latest
67+
needs: build
68+
steps:
69+
- name: Deploy to GitHub Pages
70+
id: deployment
71+
uses: actions/deploy-pages@v4

‎.github/workflows/jekyll-gh-pages.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,16 @@ jobs:
4646
cd docs
4747
npx docusaurus build
4848
49+
- name: Verify CNAME
50+
run: |
51+
if [ ! -f docs/build/CNAME ]; then
52+
echo "CNAME file not found in build directory!"
53+
echo "docs.mixcore.org" > docs/build/CNAME
54+
echo "Created CNAME file with docs.mixcore.org"
55+
else
56+
echo "CNAME file found in build directory: $(cat docs/build/CNAME)"
57+
fi
58+
4959
- name: Upload artifact
5060
uses: actions/upload-pages-artifact@v3
5161
with:

‎CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.mixcore.org

‎docs/getting-started.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Getting Started with Mixcore
6+
7+
<div className="section-container">
8+
<h2 className="section-title">Welcome to Mixcore!</h2>
9+
<p>
10+
Mixcore is an Enterprise-Grade .NET Core CMS platform that empowers developers, content creators, and businesses to build powerful applications, websites, and digital experiences.
11+
</p>
12+
</div>
13+
14+
## Step 1: Installation
15+
16+
<div className="callout callout--info">
17+
<strong>Prerequisite:</strong> Make sure you have .NET 6.0 SDK or higher installed on your system.
18+
</div>
19+
20+
You can install Mixcore in several ways:
21+
22+
<ul className="feature-list">
23+
<li>Docker installation (recommended for production)</li>
24+
<li>Local development environment</li>
25+
<li>Cloud hosting platforms</li>
26+
</ul>
27+
28+
<a href="/installation-install-mixcore" className="button--primary">View Installation Guide</a>
29+
30+
## Step 2: Create Your First Project
31+
32+
After successfully installing Mixcore, you're ready to create your first project.
33+
34+
<div className="section-container">
35+
<h3 className="section-title">Quick Start Commands</h3>
36+
37+
```bash
38+
# Clone the repository
39+
git clone https://github.com/mixcore/mix.core.git
40+
41+
# Navigate to the directory
42+
cd mix.core
43+
44+
# Run the project
45+
dotnet run
46+
```
47+
</div>
48+
49+
<div className="callout callout--tip">
50+
<strong>Tip:</strong> For the best development experience, we recommend using Visual Studio 2022 or VS Code with the C# extension.
51+
</div>
52+
53+
## Step 3: Understand Mixcore Architecture
54+
55+
<div className="section-container">
56+
<p>
57+
Mixcore follows a modular architecture that allows for flexibility and scalability. The key components include:
58+
</p>
59+
60+
<ul className="feature-list">
61+
<li>Core CMS Engine</li>
62+
<li>API Layer</li>
63+
<li>Database Abstraction</li>
64+
<li>Theme System</li>
65+
<li>Plugin Architecture</li>
66+
</ul>
67+
</div>
68+
69+
<div className="callout callout--warning">
70+
<strong>Note:</strong> Understanding the architecture is crucial for developing custom modules and themes.
71+
</div>
72+
73+
## Step 4: Explore Advanced Features
74+
75+
Mixcore comes with many powerful features out of the box:
76+
77+
<div className="section-container">
78+
<h3 className="section-title">Key Features</h3>
79+
80+
<ul className="feature-list">
81+
<li>Headless CMS capabilities</li>
82+
<li>Multi-site management</li>
83+
<li>Advanced content modeling</li>
84+
<li>User and role management</li>
85+
<li>Responsive design</li>
86+
<li>RESTful API</li>
87+
<li>Multi-language support</li>
88+
</ul>
89+
</div>
90+
91+
## Learn More
92+
93+
<div className="section-container">
94+
<p>Ready to dive deeper? Check out these resources:</p>
95+
96+
<div style={{ display: 'flex', gap: '1rem', marginTop: '1rem' }}>
97+
<a href="/dev-getting-started" className="button--primary">Developer Guide</a>
98+
<a href="/admin-guide" className="button--secondary">Admin Guide</a>
99+
<a href="/content-editor-guide" className="button--secondary">Content Editor Guide</a>
100+
</div>
101+
</div>
102+
103+
<div className="callout callout--info" style={{ marginTop: '2rem' }}>
104+
<strong>Community Support:</strong> Join our <a href="https://github.com/orgs/mixcore/discussions">GitHub Discussions</a> to connect with the community and get help.
105+
</div>
106+
107+
<div style={{ textAlign: 'center', margin: '3rem 0 1rem' }}>
108+
<p>Current Mixcore Version <span className="version-badge">7.0</span></p>
109+
</div>

0 commit comments

Comments
 (0)