mdn/rariPublic

NotificationsYou must be signed in to change notification settings
Fork22
Star29

Rari is a Rust-based build system that transforms markdown into structured JSON, powering MDN Web Docs content and translations since 2024.

License

Unknown and 2 other licenses found

Licenses found

29 stars 22 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 566 Commits
.cargo		.cargo
.github		.github
crates		crates
rari-npm		rari-npm
tests/data		tests/data
.editorconfig		.editorconfig
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
LICENSE		LICENSE
LICENSE.BSD-2-Clause		LICENSE.BSD-2-Clause
LICENSE.MIT		LICENSE.MIT
LICENSE.MPL-2.0		LICENSE.MPL-2.0
README.md		README.md
REVIEWING.md		REVIEWING.md
SECURITY.md		SECURITY.md
TODO.md		TODO.md

Repository files navigation

Welcome to`rari`

Warning

This project is work in progress and lacking most of its documentation.Anything might change and code will move a lot. We do not encourage using it yet.We'll have an official announcement before we migrate, so stay tuned.

rari is the build system forMDN.

rari is hosted byMDN.

Getting Started

To get up and running, follow these steps:

Make sure you haveRust installed, otherwise go tohttps://rustup.rs/.

Clone this repository and run:

cargo run -- --help

Configuration

Create a.config.toml in the current working directory.Add the following:

content_root ="/<ABSOLUTE-PATH-TO-mdn/content>/files"build_out_root ="/tmp/rari"

Contributing

For now we're aiming for a parity rewrite ofyari'syarn build -n. Which generates theindex.jsonfor all docs. Until we reach that point the codebase will be unstable and may change at any point. Therefore we won't accept contributions for now.

By participating in and contributing to our projects and discussions, you acknowledge that you have read and agree to ourCode of Conduct.