michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

describe how to use non-en lang in doc theme (#2447)

Browse source
This commit is contained in:
Jang Rush 2022-01-24 23:32:27 +08:00 committed by GitHub
parent ef85fcc7ab
commit 1f45d23103
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
examples/docs/README.md
View file

@ -143,10 +143,23 @@ export const SIDEBAR = {
// ...
```
If you plan to use Spanish as the the default language, you just need to modify the redirect path in `src/pages/index.astro`:
```diff
<script>
- window.location.pathname = `/en/introduction`;
+ window.location.pathname = `/es/introduction`;
</script>
```
You can also remove the above script and write a landing page in Spanish instead.
### What if I don't plan to support multiple languages?
That's totally fine! Not all projects need (or can support) multiple languages. You can continue to use this theme without ever adding a second language.
If that single language is not English, you can just replace `en` in directory layouts and configurations with the preferred language.
### Search (Powered by Algolia)
[Algolia](https://www.algolia.com/) offers a free service to qualified open source projects called [DocSearch](https://docsearch.algolia.com/). If you are accepted to the DocSearch program, provide your API Key & index name in `src/config.ts` and a search box will automatically appear in your site header.