DOCSEARCHbyAlgolia
Submit Docs

Tour of Rust

repository·master·Indexed 21 days ago

https://github.com/richardanaya/tour_of_rust

An interactive, multi-language tutorial designed to provide experienced programmers with a swift introduction to the Rust programming language as a faster alternative to traditional book-style documentation.

Tokens
516
Snippets
2
Records
2
Agent score
26%

What's inside Tour of Rust

  1. How to contribute translations

    master

    You can contribute translations by creating a Pull Request.

    1. Locate your target language under the lessons folder. Each chapter has its own file.
    2. To translate a chapter:
      • Modify an existing chapter's content.
      • Or, copy an existing English chapter file to your language folder and modify its content.
    3. Each page uses a YAML structure with the following properties:
      • title: The localized title for the page.
      • content_markdown: The localized content using Showdown markdown syntax.
      • code (optional): An "embedded link" generated from the Rust Playground via the "Share" button. Important: Always run the rustfmt tool on your code. If code is omitted, the page falls back to the English version of the code if available.

    There is also a file for common words that should be filled out to improve the site's localization experience.

    - title: Capítulo 3 - Conclusión
  content_markdown: |
    ¡Rust tiene algunos increíbles ** punteros **!

    * A
    * `let`
    * C
  code: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&code=fn%20main()%20%7B%7D%0A

  2. How to run the Tour of Rust project locally

    master

    To run the Tour of Rust website on your local machine, follow these steps:

    1. Install yq: Ensure you have the yq tool installed. This project specifically requires the version from kislyuk.github.io/yq/.
    2. Install Dependencies: Use yarn to install the necessary JavaScript dependencies.
    3. Launch the Site: Use make to start the development server.
      • Note: You must restart the server every time you make changes to see them reflected.
      • Windows Users: Use make.bat instead of make.
    yarn
make