diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..dbc65a9 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,25 @@ +name: build + +on: + pull_request: + branches: + - main + +jobs: + build: + name: build + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: 'lts/*' + + - name: Install dependencies + run: npm ci + + - name: Build VitePress site + run: npx vitepress build diff --git a/.vitepress/config.mts b/.vitepress/config.mts index c5ddccf..a72d975 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -33,4 +33,7 @@ export default defineConfig({ { icon: 'github', link: 'https://github.com/seed4j/seed4j' }, ], }, + ignoreDeadLinks: [ + /^http:\/\/localhost/ + ] }); diff --git a/docs/use-cases/index.md b/docs/use-cases/index.md index f4e740b..4bb9b48 100644 --- a/docs/use-cases/index.md +++ b/docs/use-cases/index.md @@ -6,16 +6,16 @@ title: Use Cases | Use Cases Seed4J can be used in different contexts, from quick experiments to real-world applications. This page gives you an overview of the main use cases, with dedicated guides for each. -- ๐Ÿงช [Minimal project scaffolding](./use-cases/minimal-project.md): +- ๐Ÿงช [Minimal project scaffolding](./minimal-project.md): Generate basic files like `.gitignore`, `README.md`, and license, ideal to start cleanly. -- ๐Ÿฅ‹ [Java kata project](./use-cases/java-kata.md): +- ๐Ÿฅ‹ [Java kata project](./java-kata.md): Bootstrap a simple Java app with tests, perfect for TDD sessions or coding katas. -- ๐Ÿฅ‹ [TypeScript kata project](./use-cases/ts-kata.md): +- ๐Ÿฅ‹ [TypeScript kata project](./ts-kata.md): Quickly set up a TypeScript-based kata environment with linting and tests. -- ๐Ÿš€ [Real Java backend project](./use-cases/java-backend.md): +- ๐Ÿš€ [Real Java backend project](./java-backend.md): Start a fully structured backend with Spring Boot, hexagonal architecture, and Tomcat. Each guide provides specific steps tailored to that context, so you only generate what you really need. diff --git a/docs/use-cases/java-backend.md b/docs/use-cases/java-backend.md new file mode 100644 index 0000000..64678d8 --- /dev/null +++ b/docs/use-cases/java-backend.md @@ -0,0 +1,3 @@ +--- +title: Java Backend | Use Cases +--- diff --git a/docs/use-cases/java-kata.md b/docs/use-cases/java-kata.md new file mode 100644 index 0000000..acbc6d5 --- /dev/null +++ b/docs/use-cases/java-kata.md @@ -0,0 +1,3 @@ +--- +title: Java Kata | Use Cases +--- diff --git a/docs/use-cases/minimal-project.md b/docs/use-cases/minimal-project.md new file mode 100644 index 0000000..e50e852 --- /dev/null +++ b/docs/use-cases/minimal-project.md @@ -0,0 +1,3 @@ +--- +title: Minimal project | Use Cases +--- diff --git a/docs/use-cases/ts-kata.md b/docs/use-cases/ts-kata.md new file mode 100644 index 0000000..7932236 --- /dev/null +++ b/docs/use-cases/ts-kata.md @@ -0,0 +1,3 @@ +--- +title: TypeScript Kata | Use Cases +---