Git Product home page Git Product logo

mdbook-i18n's Introduction

mdBook-i18n

Simple mdBook i18n plugin.

Installation

It requires mdbook >= 0.3.1.

# cargo install mdbook
# cargo install mdbook-i18n

Usage

  1. Add language to book section in your book.toml.
  2. Add output.i18n.translations table to your book.toml. Every record in this table must contains language and title. Also records can contains fields authors (must be array), translators (also must be array), description and src. If src not present in record, then this field creates as <book's root>/translations/<language name>.
  3. Write translations.
  4. Run mdbook build for build all books. Every book saves in destination directory in folder with locale name.

How it works?

Source book from config converts to translation config. Common configs shares between all translations. After that mdbook runs for every translation.

Limitations

  1. Custom values from main config don't send to mdbook config. For now this project used native RenderContext what have private rest field in config (this field contains custom values from config).
  2. Books don't share assets. Because native render of mdbook can build only one build, every build generate full tree of assets.
  3. Books don't has links to different l10n. Because used native render without custom templates.
  4. Maybe everything else what i forget.

License

MIT

mdbook-i18n's People

Contributors

funkill avatar dependabot-preview[bot] avatar 44ka28ta avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.