Skip to content

Commit 5661f5c

Browse files
authored
Update README.md with instructions on running the Astro site locally
1 parent 61b2e28 commit 5661f5c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,22 @@ It aims to inform on the impacts on consumers, developers, states and coordinate
1414
3. Make the changes.
1515
4. Create a pull request.
1616

17+
## Running the site locally
18+
19+
This is an Astro site, so you should be able to check out your fork locally and run it as per the [docs](https://docs.astro.build/en/develop-and-build/#start-the-astro-dev-server) with:
20+
21+
```
22+
npm run dev
23+
```
24+
25+
The site should run locally and be browsable at [http://localhost:4321/](http://localhost:4321/).
26+
1727
## Translations Needed!
1828

1929
To provide a translation into a new language like Italian (language code: "it"):
2030

21-
1. [Edit the `_layouts/default.html`](https://github.com/keepandroidopen/keepandroidopen.github.io/edit/main/_layouts/default.html) in a fork and update the language menu at the end with the new language code.
22-
2. Create a new top-level file `index-<langcode>.md` and add the translation of the English `index.md` file. Translate the markdown headers and page content. The most important text is at the beginning; the lists of links do not all need to be translated.
31+
1. [Edit `astro.config.mjs`](https://github.com/keepandroidopen/keepandroidopen.github.io/edit/main/astro.config.mjs) in a fork and update the language menu at the end with the new language code.
32+
2. Create a new folder in [`src/content/pages/`](https://github.com/keepandroidopen/keepandroidopen.github.io/tree/main/src/content/pages/) and add the translation of the English `index.md` file. Translate the markdown headers and page content. The most important text is at the beginning; the lists of links do not all need to be translated.
2333
3. Commit changes to your fork and file a Pull Request with your translation.
2434

2535
## License

0 commit comments

Comments
 (0)