An open API service indexing awesome lists of open source software.

https://github.com/multivers-dev/angular-cookbook

Angular Cookbook Recipes
https://github.com/multivers-dev/angular-cookbook

angular cookbook mdbook rust

Last synced: 4 months ago
JSON representation

Angular Cookbook Recipes

Awesome Lists containing this project

README

          

![Angular](https://img.shields.io/badge/angular-%23DD0031.svg?style=for-the-badge&logo=angular&logoColor=white) CookBook
=============

[_Angular CookBook_](https://multivers-dev.github.io/angular-cookbook/en) is an Open Source Angular Knowledge Project built for and by the community.

You can edit existing pages via top right pen icon button and propose Pull Request without having to open vscode.
For new article, just create a folder and a markdown file you can also follow instructions below to project locally

# Table of Contents
- [How to Install ?](#how-to-install-)
- [Prerequisites](#prerequisites)
- [Rust](#rust)
- [dependencies](#dependencies)
- [Builds](#builds)
- [Serve](#serve)
- [How to Contribute ?](#how-to-contribute)

# How to Install ?

## Prerequisites

> ***For the installation of the project, you need to install and use a bash terminal.***
> you can use [git bash](https://git-scm.com/downloads) or [cmder](https://cmder.net/)

### Rust
>### ![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
>
> The way to install rustup differs by platform:
> * On Unix:
> ``` shell
> curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
> ```
> in your shell, This downloads and runs rustup-init.sh
>
> * On Windows download and run rustup-init.exe from [here](https://www.rust-lang.org/tools/install)
>
> ___
>
> For more information about installation of rustup, see the [rustup documentation](https://forge.rust-lang.org/infra/other-installation-methods.html).
>

# Dependencies

>[`rustc`](https://www.rust-lang.org/tools/install) = 1.71.0


### ![mdbook](https://img.shields.io/badge/mdbook-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
```sh
cargo install mdbook
```
[`mdbook`](https://github.com/rust-lang/mdBook) = "^0.4.35"


### ![Cargo](https://img.shields.io/badge/cargo-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
Install dependencies from Cargo.toml
```sh
cargo install --path .
```

### ![mdbook-admonish](https://img.shields.io/badge/mdbook--admonish-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
```sh
cargo install mdbook-admonish
```
[`mdbook-admonish`](https://crates.io/crates/mdbook-admonish) = "^1.13.1"


### ![mdbook-i18n-helpers](https://img.shields.io/badge/mdbook--i18n--helpers-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
```sh
cargo install mdbook-i18n-helpers
```
[`mdbook-i18n-helpers`](https://github.com/google/mdbook-i18n-helpers) = "^0.2.4"

### i18n
> ## ![i18n](https://img.shields.io/badge/i18n-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
>* Run
> ```sh
> MDBOOK_OUTPUT='{"xgettext": {"pot-file": "messages.pot"}}' \ mdbook build -d po
> ```
> or
> ```sh
> MDBOOK_OUTPUT='{"xgettext": {"pot-file": "messages.pot"}}' mdbook build -d po
> ```
>
>
>* Update existing po for fr
> ```sh
> msgmerge --update po/fr.po po/messages.pot
> ```
>* Update existing po for en
> ```sh
> msgmerge --update po/en.po po/messages.pot
> ```

# Builds

>* Run `build` in fr
>
>```sh
> MDBOOK_BOOK__LANGUAGE=fr mdbook build -d >book/fr
>```
>
>* Run `build` in en
>
>```sh
> MDBOOK_BOOK__LANGUAGE=en mdbook build -d >book/en
>```

# Serve

>* Run `serve` in fr
>
> ```sh
>MDBOOK_BOOK__LANGUAGE=fr mdbook serve -d book/fr -p 3000
>```
>
>* Run `serve` in en
>
>```sh
>MDBOOK_BOOK__LANGUAGE=en mdbook serve -d book/en -p 3001
>```

## [How to Contribute?](./CONTRIBUTING.md)