Skip to content

Commit 0d457b7

Browse files
committed
docs: enhance readme
1 parent 43ab91f commit 0d457b7

2 files changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,34 @@
22

33
An Astro theme, focused on internationalization.
44

5+
[👀 **DEMO**](https://openscript.github.io/astro-theme-international)
6+
57
## Usage
68

79
<details>
810
<summary>🛠️ How to use this theme?</summary>
911

10-
1. Use this repository as a template.
12+
1. Use this repository as a template. <br> [![Use this template](./res/use-this-template.png)](https://github.com/new?template_name=astro-theme-international&template_owner=openscript)
1113
1. Enable Github Pages in the repository settings: <br> ![Enable Github Pages](./res/enable-github-pages.png)
1214
1. Open the repository with Visual Studio Code.
13-
1. Make sure you have Docker and the Dev Containers extension installed.
15+
1. Make sure you have [Docker](https://docs.docker.com/desktop/) and the [Dev Containers extension](https://code.visualstudio.com/docs/devcontainers/containers#_installation) installed.
1416
1. Open the repository in a Dev Container.
15-
1. Start making your changes.
17+
1. Start making changes.
1618

1719
</details>
1820

1921
<details>
2022
<summary>🎁 How to contribute to this theme?</summary>
2123

2224
1. Fork the project.
23-
1. Add your changes.
25+
1. Make your changes.
2426
1. Open a pull request.
2527

2628
</details>
2729

2830
## Features
2931

30-
- Internationalization
32+
- Internationalization and Localization by using [astro-loader-i18n](https://github.com/openscript/astro-loader-i18n)
3133
- UI translations
3234
- Content translations
3335
- Route translations
@@ -43,8 +45,8 @@ An Astro theme, focused on internationalization.
4345
- Compatible with [Github Pages](https://pages.github.com/)
4446
- Works on a subpath (e.g. `http://example.com/my-cool-astro-site/`)
4547
- MDX support [(@astrojs/mdx)](https://docs.astro.build/en/guides/mdx/)
46-
- Release cycle including generating changelogs with [changesets](https://github.com/changesets/changesets)
47-
- .editorconfig
48+
- Release cycle including changelogs generation with [changesets](https://github.com/changesets/changesets)
49+
- [.editorconfig](https://editorconfig.org/)
4850
- Connectivity
4951
- RSS Feeds with i18n support [(@astrojs/rss)](https://docs.astro.build/en/guides/rss/)
5052
- Sitemaps with i18n support [(@astrojs/sitemap)](https://docs.astro.build/en/guides/integrations-guide/sitemap/)
@@ -73,7 +75,6 @@ An Astro theme, focused on internationalization.
7375

7476
### Sections
7577

76-
7778
## Resources
7879

7980
- Fonts: https://fontsource.org/

res/use-this-template.png

2.23 KB
Loading

0 commit comments

Comments
 (0)