https://github.com/aplinkosministerija/biip-docs

BĮIP projekto dokumentacija
https://github.com/aplinkosministerija/biip-docs

biip documentation

Last synced: 21 days ago
JSON representation

BĮIP projekto dokumentacija

• Host: GitHub
• URL: https://github.com/aplinkosministerija/biip-docs
• Owner: AplinkosMinisterija
• License: mit
• Created: 2024-01-23T11:27:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-08-27T09:55:57.000Z (10 months ago)
• Last Synced: 2025-11-23T02:29:28.915Z (7 months ago)
• Topics: biip, documentation
• Language: JavaScript
• Homepage: https://docs.biip.lt/
• Size: 178 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# BĮIP Project Documentation

Welcome to the official documentation for the BĮIP project.

[![License](https://img.shields.io/github/license/AplinkosMinisterija/biip-docs)](https://github.com/AplinkosMinisterija/biip-docs/blob/main/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/AplinkosMinisterija/biip-docs)](https://github.com/AplinkosMinisterija/biip-docs/issues)

[![GitHub stars](https://img.shields.io/github/stars/AplinkosMinisterija/biip-docs)](https://github.com/AplinkosMinisterija/biip-docs/stargazers)

## Table of Contents

- [Getting Started](#getting-started)

    - [Installation](#installation)

    - [Usage](#usage)

- [Deployment](#deployment)

- [Contributing](#contributing)

- [License](#license)

## Getting Started

If you're new to the BĮIP documentation, here's how to get started:

### Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/AplinkosMinisterija/biip-docs.git

   ```

2. Ensure you have Rust and Cargo installed. You can follow the instructions on

   the [Rust installation page](https://www.rust-lang.org/tools/install).

3. Install `mdbook` and required dependencies:

   ```bash

   cargo install mdbook mdbook-mermaid mdbook-linkcheck

   ```

### Usage

To use the documentation:

1. Preview documentation (additional commands in `package.json`):

   ```bash

   mdbook serve

   ```

## Deployment

### Preview

Each commit automatically creates a new preview environment on pull requests to the `main` branch.

### Production

Each commit to `main` branch automatically creates deployment to production environment.

## Contributing

We welcome contributions! If you encounter issues or have suggestions for improvements, feel free to open

an issue or submit a pull request. For more information, please refer to

the [contribution guidelines](https://github.com/AplinkosMinisterija/.github/blob/main/CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](./LICENSE).