diff --git a/docs.old/book.toml b/docs.old/book.toml deleted file mode 100644 index 9443a3e..0000000 --- a/docs.old/book.toml +++ /dev/null @@ -1,14 +0,0 @@ -[book] -authors = ["zava"] -language = "en" -multilingual = false -src = "src" -title = "AutoPipeline Document" -description = "The document for AutoPipeline." - -[output.html] -default-theme = "light" -git-repository-url = "https://github.com/foldright/auto-pipeline" -git-repository-icon = "fa-github" -edit-url-template = "https://github.com/foldright/auto-pipeline/edit/main/doc/{path}" -site-url = "/doc/" diff --git a/docs.old/src/SUMMARY.md b/docs.old/src/SUMMARY.md deleted file mode 100644 index 754d5dd..0000000 --- a/docs.old/src/SUMMARY.md +++ /dev/null @@ -1,6 +0,0 @@ -# Summary - -- [Introduction](./readme.md) -- [Quick Start](./quick-start.md) -- [Pipeline direction](./pipeline-direction.md) -- [Examples](./examples.md) diff --git a/docs.old/src/pipeline-direction.md b/docs.old/src/pipeline-direction.md deleted file mode 100644 index 75b6803..0000000 --- a/docs.old/src/pipeline-direction.md +++ /dev/null @@ -1,21 +0,0 @@ -# Pipeline Direction - -the auto-pipeline also introduced the `@PipelineDirection` annotation for the pipeline. - -## specify the direction - -to specify the direction of the pipeline, which can be used on methods or interfaces(must be annotated with `@AutoPipeline`). -the default direction is `@Direction.FORWARD`, here's the rules: - -- rule1: in the `@AutoPipelin` interface's method, we can: - - add `Direction.FORWARD` to apply the interface's method, the annotated method will be called from head to tail - - add `Direction.REVERSE` to apply the interface's method, the annotated method will be called from tail to head - - if there's no `Direction annotation` to the method, the direction of pipeline will follow the `Direction` in the in the `@AutoPipeline` interface, see rule2 - - `Direction.FORWARD` and `Direction.REVERSE` are mutually exclusive, they cannot coexist -- rule2: in the `@AutoPipeline` interface, we can: - - add `Direction.FORWARD` to the `@AutoPipeline` interface, the methods declared in this interface will be called from head to tail unless the method is annotated with `Direction` in the method level - - add `Direction.REVERSE` to the `@AutoPipeline` interface, the methods declared in this interface will be called from tail to head unless the method is annotated with `Direction` in the method level - - if no `Direction` annotation to the `@AutoPipeline` interface, it equals to add `Direction.FORWARD` to the `@AutoPipeline` interface - - `Direction.FORWARD` and `Direction.REVERSE` are mutually exclusive, they cannot coexist - -for examples, please check the [RPC example](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/main/java/com/foldright/examples/duplexing/RPC.java) and the [test case](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/test/java/com/foldright/examples/duplexing/pipeline/RPCTest.kt). diff --git a/docs.old/src/quick-start.md b/docs.old/src/quick-start.md deleted file mode 100644 index 74c7927..0000000 --- a/docs.old/src/quick-start.md +++ /dev/null @@ -1,148 +0,0 @@ -# Quick Start - -`auto-pipeline` requires java 8 or above. - -## 0. add `auto-pipeline` dependencies - -`auto-pipeline` has published to maven central, click here -to [find the latest version](https://search.maven.org/search?q=g:com.foldright.auto-pipeline). - -### for `maven` project: - -```xml - - - - com.foldright.auto-pipeline - auto-pipeline-processor - 0.3.0 - provided - - -``` - -for `gradle` project: - -```kotlin -/* - * Gradle Kotlin DSL - */ -// the auto-pipeline annotation will be used in your interface type -compileOnly("com.foldright.auto-pipeline:auto-pipeline-annotations:0.3.0") -// the auto-pipeline annotation processor will generate the pipeline classes for the interface. -// use "annotationProcessor" scope because it's only needed at annotation processing time. -annotationProcessor("com.foldright.auto-pipeline:auto-pipeline-processor:0.3.0") - -/* - * Gradle Groovy DSL - */ -compileOnly 'com.foldright.auto-pipeline:auto-pipeline-annotations:0.3.0' -annotationProcessor 'com.foldright.auto-pipeline:auto-pipeline-processor:0.3.0' -``` - -## 1. using `@AutoPipeline` to auto generate pipeline for your interface - -annotate `@AutoPipeline` to your interface, and `auto-pipeline` will generate some java files for the interface at compile time. - -let's check the [`ConfigSource`](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/main/java/com/foldright/examples/config/ConfigSource.java) as an example: - -given an interface named `ConfigSource`, the `ConfigSource` has the `get()` method, input a string as key and output a string as the value. -like this: - -```java -public interface ConfigSource { - String get(String key); -} -``` - -say, we want `ConfigSource#get()` has some extensibility, so we decide to apply the `chain of responsibility` pattern to it for extensibility. - -Now it's `auto-pipeline`'s turn to play a role, we simply add `@AutoPipelin` to `ConfigSource`： - -```java -@AutoPipeline -public interface ConfigSource { - String get(String key); -} -``` - -`auto-pipeline-processor` will auto generate pipeline java files for `ConfigSource` into subpackage `pipeline` when compiled: - -- `ConfigSourceHandler` the responsibility interface we want to implement for extensibility -- `ConfigSourcePipeline` the chain -- `ConfigSourceHandlerContext` -- `AbstractConfigSourceHandlerContext` -- `DefaultConfigSourceHandlerContext` - -## Implementing your handler for pipeline - -we can implement `MapConfigSourceHandler` and `SystemConfigSourceHandler` (they are all in the [ConfigSource handler example](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/main/java/com/foldright/examples/config/handler)): - -```java -public class MapConfigSourceHandler implements ConfigSourceHandler { - private final Map map; - - public MapConfigSourceHandler(Map map) { - this.map = map; - } - - @Override - public String get(String key, ConfigSourceHandlerContext context) { - String value = map.get(key); - if (StringUtils.isNotBlank(value)) { - return value; - } - return context.get(key); - } -} -``` - -```java -public class SystemConfigSourceHandler implements ConfigSourceHandler { - public static final SystemConfigSourceHandler INSTANCE = new SystemConfigSourceHandler(); - - @Override - public String get(String key, ConfigSourceHandlerContext context) { - String value = System.getProperty(key); - if (StringUtils.isNotBlank(value)) { - return value; - } - return context.get(key); - } -} -``` - -## 3. use the pipeline - -create a `ConfigSourcePipeline` by composing `ConfigSourceHandler`s which can ben an entrance of the `ConfigSource`: - -```java -Map mapConfig = new HashMap(); -mapConfig.put("hello", "world"); -ConfigSourceHandler mapConfigSourceHandler = new MapConfigSourceHandler(mapConfig); - -ConfigSource pipeline = new ConfigSourcePipeline() - .addLast(mapConfigSourceHandler) - .addLast(SystemConfigSourceHandler.INSTANCE); -``` - - -now, we can use the `pipeline.get(...)` to invoke the chain! 🎉 - -```java -pipeline.get("hello"); -// get value "world" -// from mapConfig / mapConfigSourceHandler - -pipeline.get("java.specification.version") -// get value "1.8" -// from system properties / SystemConfigSourceHandler -``` - -## What's next: - diff --git a/docs.old/src/readme.md b/docs.old/src/readme.md deleted file mode 100644 index 26a82b2..0000000 --- a/docs.old/src/readme.md +++ /dev/null @@ -1,6 +0,0 @@ -# AutoPipeline Introduction - -`auto-pipeline` is a source code generator that auto generate the component's pipeline. Help you to keep your project smaller, simpler, and more extensible. 💡 - -`auto-pipeline` is an [`annotation-processor`](https://docs.oracle.com/javase/8/docs/api/javax/annotation/processing/package-summary.html) for `Pipeline` generation, which is inspired by -Google's [`Auto`](https://github.com/google/auto). ❤️ diff --git a/docs/docs/tutorial-advanced/01-direction.md b/docs/docs/tutorial-advanced/01-direction.md new file mode 100644 index 0000000..5e0c01b --- /dev/null +++ b/docs/docs/tutorial-advanced/01-direction.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 1 +--- +# Pipeline Direction + +The auto-pipeline also introduced the `@PipelineDirection` annotation for the pipeline. + +## Specify the direction + +We can specify the direction on methods or interfaces. + +The default direction is `@Direction.FORWARD`, here's the rules: + +- Rule1: in the `@AutoPipelin` interface's method, we can: + - add `Direction.FORWARD` to apply the interface's method, the annotated method will be called from head to tail + - add `Direction.REVERSE` to apply the interface's method, the annotated method will be called from tail to head + - if there's no `Direction annotation` to the method, the direction of pipeline will follow the `Direction` in the in the `@AutoPipeline` interface, see rule2 + - `Direction.FORWARD` and `Direction.REVERSE` are mutually exclusive, they cannot coexist +- Rule2: in the `@AutoPipeline` interface, we can: + - add `Direction.FORWARD` to the `@AutoPipeline` interface, the methods declared in this interface will be called from head to tail unless the method is annotated with `Direction` in the method level + - add `Direction.REVERSE` to the `@AutoPipeline` interface, the methods declared in this interface will be called from tail to head unless the method is annotated with `Direction` in the method level + - if no `Direction` annotation to the `@AutoPipeline` interface, it equals to add `Direction.FORWARD` to the `@AutoPipeline` interface + - `Direction.FORWARD` and `Direction.REVERSE` are mutually exclusive, they cannot coexist + +## Direction example +For examples, please check the [RPC example](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/main/java/com/foldright/examples/duplexing/RPC.java) and the [test case](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/test/java/com/foldright/examples/duplexing/pipeline/RPCTest.kt). diff --git a/docs/docs/tutorial-extras/_category_.json b/docs/docs/tutorial-advanced/_category_.json similarity index 100% rename from docs/docs/tutorial-extras/_category_.json rename to docs/docs/tutorial-advanced/_category_.json diff --git a/docs/docs/tutorial-basics/01-quick-start.md b/docs/docs/tutorial-basics/01-quick-start.md index 37b375f..5596419 100644 --- a/docs/docs/tutorial-basics/01-quick-start.md +++ b/docs/docs/tutorial-basics/01-quick-start.md @@ -175,3 +175,4 @@ That's all, the `@AutoPipeline` help you generate the Pipeline Design Pattern Co ## What's next? - check the runnable [test case](https://github.com/foldright/auto-pipeline/blob/main/auto-pipeline-examples/src/test/java/com/foldright/examples/config/pipeline/ConfigSourceTest.kt) for details. +- check out the [example project](https://github.com/foldright/auto-pipeline/tree/main/auto-pipeline-examples/src/main/java/com/foldright/examples) diff --git a/docs.old/src/examples.md b/docs/docs/tutorial-basics/02-examples.md similarity index 84% rename from docs.old/src/examples.md rename to docs/docs/tutorial-basics/02-examples.md index 022bcd6..b25aa11 100644 --- a/docs.old/src/examples.md +++ b/docs/docs/tutorial-basics/02-examples.md @@ -1,3 +1,8 @@ +--- +sidebar_position: 2 +--- # Examples check out the [example project](https://github.com/foldright/auto-pipeline/tree/main/auto-pipeline-examples/src/main/java/com/foldright/examples) + + diff --git a/docs/docs/tutorial-basics/congratulations.md b/docs/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/docs/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/docs/tutorial-basics/create-a-blog-post.md b/docs/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 550ae17..0000000 --- a/docs/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/docs/tutorial-basics/create-a-document.md b/docs/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe29..0000000 --- a/docs/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/docs/tutorial-basics/deploy-your-site.md b/docs/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/docs/tutorial-basics/markdown-features.mdx b/docs/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 35e0082..0000000 --- a/docs/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - -```md -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: -``` - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164..0000000 Binary files a/docs/docs/tutorial-extras/img/docsVersionDropdown.png and /dev/null differ diff --git a/docs/docs/tutorial-extras/img/localeDropdown.png b/docs/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc..0000000 Binary files a/docs/docs/tutorial-extras/img/localeDropdown.png and /dev/null differ diff --git a/docs/docs/tutorial-extras/manage-docs-versions.md b/docs/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index ccda0b9..0000000 --- a/docs/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/docs/tutorial-extras/translate-your-site.md b/docs/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index b5a644a..0000000 --- a/docs/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -export default { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index a5e4a3f..4b0b62d 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -4,7 +4,7 @@ import type * as Preset from '@docusaurus/preset-classic'; const config: Config = { title: 'Auto Pipeline', - tagline: "auto generate your component's pipeline code. keep your project smaller, simpler, and more extensible.💡", + tagline: "Pipeline pattern have never been easier 🚀", favicon: 'img/favicon.ico', // Set the production url of your site here @@ -12,7 +12,7 @@ const config: Config = { // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' baseUrl: '/auto-pipeline/', - + // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. @@ -72,7 +72,8 @@ const config: Config = { position: 'left', label: 'Tutorial', }, - {to: '/blog', label: 'Blog', position: 'left'}, + {to: '/docs/tutorial-basics/quick-start', label: 'Quick Start', position: 'left'}, + {to: '/docs/tutorial-basics/examples', label: 'Examples', position: 'left'}, { href: 'https://github.com/foldright/auto-pipeline', label: 'GitHub', @@ -133,7 +134,8 @@ const config: Config = { } satisfies Preset.ThemeConfig, customFields: { - + //tagline2: "Keep your project smaller, simpler, and more extensible.💡", + tagline2: "auto generate your component's pipeline code 😁", }, }; diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index bab424b..333b7c3 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -16,12 +16,15 @@ function HomepageHeader() { {siteConfig.title} autopipeline Logo -

{siteConfig.tagline}

+

+ {siteConfig.tagline}
+ {siteConfig.customFields.tagline2 as string} +

- AutoPipeline Tutorial - 2min ⏱️ + Quick Start - 5min ⏱️
diff --git a/docs/src/pages/markdown-page.md b/docs/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b..0000000 --- a/docs/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages.