Skip to content

Commit

Permalink
Update copy
Browse files Browse the repository at this point in the history
  • Loading branch information
pontusab committed Feb 3, 2025
1 parent a80ed85 commit 48726c1
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 6 deletions.
55 changes: 55 additions & 0 deletions apps/web/src/markdown/docs/en/github-actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,61 @@ This saves you a lot of time and effort while maintaining high quality translati

---

## How it works



<div className="flex flex-col items-center justify-center p-4 mb-8 h-[400px] sm:h-[500px] md:h-[650px]">
<pre
className="p-4 text-sm leading-5 scale-[0.5] sm:scale-[0.65] md:scale-90 transform-gpu"
style={{
fontFamily: "monospace",
whiteSpace: "pre",
textAlign: "left",
}}
>
{`
┌───────────────┐
│ Git Push │
└───────────────┘
┌─────────────────────────────────────────────────────────┐
│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░░░░░░ Languine Engine ░░░░░░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────┘
─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┼ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─
│ │ │
▼ ▼ ▼
╔═══════════════════╗ ╔═══════════════════╗ ╔═══════════════════╗
║ ║ ║ ║ ║ ║
║ English ║ ║ Spanish ║ ║ Japanese ║
║ Translation ║ ║ Translation ║ ║ Translation ║
║ ║ ║ ║ ║ ║
╚═══════════════════╝ ╚═══════════════════╝ ╚═══════════════════╝
│ │ │
└──────────────────────────────┼──────────────────────────────┘
┌───────────────┐
│ Merge │
│ Pull Request │
└───────────────┘
┌─────────────────────┐
│ Completed │
│ (Deploy) │
└─────────────────────┘
`}
</pre>
</div>

---

## Installation

To use the Languine GitHub Action in your repository, you'll need to:
Expand Down
4 changes: 1 addition & 3 deletions apps/web/src/markdown/docs/en/md.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ First, make sure you've got a languine.config.json or languine.config.ts config
},
"files": {
"md": {
"include": ["content/[locale]/**/*.md"],
"frontMatter": true, // Optional: defaults to true
"translateFrontMatterFields": ["title", "description"] // Optional: specify which front matter fields to translate
"include": ["content/[locale]/**/*.md"]
}
}
}
Expand Down
4 changes: 1 addition & 3 deletions apps/web/src/markdown/docs/en/mdx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ First, make sure you've got a languine.config.json or languine.config.ts config
},
"files": {
"mdx": {
"include": ["content/[locale]/**/*.mdx"],
"frontMatter": true, // Optional: defaults to true
"translateFrontMatterFields": ["title", "description"] // Optional: specify which front matter fields to translate
"include": ["content/[locale]/**/*.mdx"]
}
}
}
Expand Down
5 changes: 5 additions & 0 deletions apps/web/src/markdown/docs/en/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ npx languine@latest init

Follow the steps to set up your project.

---

## First Translation

Now you are ready to translate your code.
Expand All @@ -34,6 +36,7 @@ Start by adding a key to your source file, for example if you choose to use `en.

```

---

## Translate

Expand All @@ -50,6 +53,8 @@ npx languine@latest translate

The lock file helps Languine identify which translations need updates when your source content changes. Make sure to commit this file to your repository.

---

## Next Steps

Now that you have Languine set up, you can:
Expand Down

0 comments on commit 48726c1

Please sign in to comment.