ara-lang / ara-lang.io

Documentation website for Ara programming language 🕸

ara-lang.io

This repository contains the source code for ARA's documentation website.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Have a look at CONTRIBUTING.md for more information.

Credits

• Nicolas Hedger
• Saif Eddin Gmati
• All contributors

ara-lang.io's Issues

Create a landing page

This issue tracks the creation of a landing page for the Ara Programming Language.

I suggest using Vitepress to create the landing page for the following reasons:

• Top notch DX will lower the barrier to entry and encourage contributions.
• Easy to setup on GitHub Actions to automate deployment.
• Can easily evolve in a fully-fledged documentation website.

I'll start working on an initial draft shortly and will reference the PR here at a later stage.

Code highlighting

This issue tracks the implementation of code highlighting in the documentation.

Vitepress uses Shiki to highlight code and it is possible to add support for our own language using a tmLanguage file.

There is a fair chance that ara-lang/highlighting already provides the necessary building blocks for this.

Ref: https://github.com/shikijs/shiki/blob/main/docs/languages.md#supporting-your-own-languages-with-shiki

Search capability

The documentation should probably be searchable so we can more easily find information.

Vitepress comes with Algolia support.

I think we should apply for Algolia Docsearch @azjezz.

Contribution guide

This issue tracks the creation of a contribution guide to help contributors get started.

• Setting up the project locally
• Running and compiling the documentation locally

you can get inspired by ar-php or contribute to it

Hello @azjezz

I like you are doing something related to Arabic and PHP.

you can watch this library to get inspired from or to contribute to: https://github.com/khaled-alshamaa/ar-php

have a nice day.