-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
5,562 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # Sample workflow for building and deploying a VitePress site to GitHub Pages | ||
| # | ||
| name: Deploy Pages | ||
|
|
||
| on: | ||
| # Runs on pushes targeting the `main` branch. Change this to `master` if you're | ||
| # using the `master` branch as the default branch. | ||
| push: | ||
| branches: [docs] | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: pages | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| # Build job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 # Not needed if lastUpdated is not enabled | ||
| # - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm | ||
| # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun | ||
| - name: Setup Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm # or pnpm / yarn | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
| - name: Install dependencies | ||
| run: npm ci # or pnpm install / yarn install / bun install | ||
| - name: Build with VitePress | ||
| run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: docs/.vitepress/dist | ||
|
|
||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| name: Deploy | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| import {defineConfig} from 'vitepress' | ||
|
|
||
| // https://vitepress.dev/reference/site-config | ||
| export default defineConfig({ | ||
| title: "DDD Modules", | ||
| description: "Modules for domain-driven implementations in PHP.", | ||
| base: '/ddd-modules/', | ||
| themeConfig: { | ||
| // https://vitepress.dev/reference/default-theme-config | ||
| nav: [ | ||
| { | ||
| text: 'Guide', | ||
| link: '/guide/', | ||
| }, | ||
| ], | ||
|
|
||
| sidebar: { | ||
| '/guide/': [ | ||
| { | ||
| text: 'Introduction', | ||
| collapsed: false, | ||
| items: [ | ||
| {text: 'What is DDD Modules?', link: '/guide/'}, | ||
| {text: 'Installation', link: '/guide/installation'}, | ||
| ], | ||
| }, | ||
| { | ||
| text: 'Core Concepts', | ||
| collapsed: false, | ||
| items: [ | ||
| {text: 'Overview', link: '/guide/concepts/'}, | ||
| {text: 'Bounded Contexts', link: '/guide/concepts/bounded-contexts'}, | ||
| {text: 'Layers', link: '/guide/concepts/layers'}, | ||
| {text: 'Encapsulation', link: '/guide/concepts/encapsulation'}, | ||
| {text: 'Modularisation', link: '/guide/concepts/modularisation'}, | ||
| ], | ||
| }, | ||
| { | ||
| text: 'Domain Layer', | ||
| collapsed: false, | ||
| items: [ | ||
| {text: 'Entities & Aggregates', link: '/guide/domain/entities'}, | ||
| {text: 'Value Objects', link: '/guide/domain/value-objects'}, | ||
| {text: 'Domain Events', link: '/guide/domain/events'}, | ||
| {text: 'Services', link: '/guide/domain/services'}, | ||
| ], | ||
| }, | ||
| { | ||
| text: 'Infrastructure Layer', | ||
| collapsed: true, | ||
| items: [ | ||
| {text: 'Asynchronous Processing', link: '/guide/infrastructure/queues'}, | ||
| {text: 'Outbox & Inbox', link: '/guide/infrastructure/outbox-inbox'}, | ||
| {text: 'Persistence', link: '/guide/infrastructure/persistence'}, | ||
| {text: 'Units of Work', link: '/guide/infrastructure/units-of-work'}, | ||
| ], | ||
| }, | ||
| { | ||
| text: 'Application Layer', | ||
| collapsed: false, | ||
| items: [ | ||
| {text: 'Commands', link: '/guide/application/commands'}, | ||
| {text: 'Queries', link: '/guide/application/queries'}, | ||
| {text: 'Integration Events', link: '/guide/application/events'}, | ||
| ], | ||
| }, | ||
| { | ||
| text: 'Toolkit', | ||
| collapsed: true, | ||
| items: [ | ||
| {text: 'Assertions', link: '/guide/toolkit/assertions'}, | ||
| {text: 'Identifiers', link: '/guide/toolkit/identifiers'}, | ||
| {text: 'Iterables', link: '/guide/toolkit/iterables'}, | ||
| ], | ||
| } | ||
| ], | ||
| }, | ||
|
|
||
| socialLinks: [ | ||
| { | ||
| icon: 'github', | ||
| link: 'https://github.com/cloudcreativity/ddd-modules', | ||
| }, | ||
| ], | ||
|
|
||
| footer: { | ||
| message: 'Released under the MIT License.', | ||
| copyright: 'Copyright © 2024 Cloud Creativity Ltd', | ||
| }, | ||
|
|
||
| outline: 'deep', | ||
| }, | ||
| }) |
Oops, something went wrong.