Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

content: enhance README #1132

Merged
merged 3 commits into from
Dec 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,25 @@ modification time, include `(last-update-skip)` somewhere in the commit message.
```shell
npm i
```
2. **Start developing**

2. **Start developing.**

To start your project up run
To start your project up run.

```shell
npm run dev
```

Your site is now running at http://localhost:8000!

3. **Build static website (production).**
3. **Prepare previews of the design system**

Download and generate examples via the [Bootstrap Italia](https://italia.github.io/bootstrap-italia/) API.

```shell
npm run prepare-content
```

4. **Build static website (production)**

To build a static version of this website, start the build process.

Expand All @@ -48,7 +55,18 @@ modification time, include `(last-update-skip)` somewhere in the commit message.

Your statically generated site is placed inside the `public` directory.

4. **Learn more**
5. **Validate your work**

To lint and "prettify" your code.

```shell
npm run lint:fix
```
```shell
npm run prettier:fix
```

6. **Learn more**

- [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

Expand Down
Loading