Improved docs

This commit is contained in:
2024-07-19 13:08:59 +02:00
parent 577d61ed42
commit bf27a344e1
9 changed files with 162 additions and 166 deletions

View File

@@ -10,22 +10,22 @@ type FeatureItem = {
const FeatureList: FeatureItem[] = [
{
title: 'Initialize a skeleton project quickly',
title: 'Initialize a Skeleton Project Quickly',
Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
description: (
<>
Initialize a skeleton project that supports FastAPI and SQLAlchemy with a single command.
Here is an example. <code>m4g init todo-app</code>
Start a new FastAPI and SQLAlchemy project with a single command.
For example: <code>m4g init todo-app</code>
</>
),
},
{
title: 'Generate common items',
title: 'Generate Common Items',
Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
description: (
<>
MycroForge allows you to generate boilerplate code for common items like entities, service & routers.
It can even generate a basic CRUD setup around an entity!
Use MycroForge to generate boilerplate code for entities, services, and routers.
It even supports basic CRUD setup!
</>
),
},
@@ -34,15 +34,15 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
description: (
<>
Extend MycroForge with your own commands by creating a plugin!
Create plugins to extend MycroForge with your own custom commands.
</>
),
},
];
function Feature({title, Svg, description}: FeatureItem) {
function Feature({ title, Svg, description }: FeatureItem) {
return (
<div className={clsx('col col--4')}>
<div className={clsx('col col--4', styles.feature)}>
<div className="text--center">
<Svg className={styles.featureSvg} role="img" />
</div>

View File

@@ -20,7 +20,7 @@ function HomepageHeader() {
<Link
className="button button--secondary button--lg"
to="/docs/intro">
MycroForge Tutorial
Get started now!
</Link>
</div>
</div>