Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Introligo Documentation
Logo
Introligo Documentation

Documentation:

  • ℹ️ About
    • πŸ“„ License
    • πŸ“‹ Changelog
    • 🀝 Contributing
    • πŸ“š Resources
  • 🌐 Language Support
    • Language Support Overview
    • Python Language Support
    • C/C++ Language Support
    • Go Language Support
    • LaTeX & Mathematical Formulas
    • Java Language Support
    • Rust Language Support
  • πŸ“– User Guide
    • πŸš€ Basic Usage Examples
    • πŸ”§ Sphinx Integration
    • πŸ“ Markdown Includes
      • πŸ“š Basic Usage
      • 🎯 Best Practices
      • πŸ’Ό Use Cases
      • πŸ”§ Troubleshooting
      • πŸ”— Link Conversion
      • πŸ’‘ Link Examples
      • πŸ–ΌοΈ Working with Images
    • πŸ“˜ Sphinx Configuration Tutorial
      • 1️⃣ Introduction
      • 2️⃣ Configuration
      • 3️⃣ Themes and Colors
      • 4️⃣ Advanced Features
    • 🎨 Theme Motifs
    • 🐳 Development Containers
      • 1️⃣ Running Code in Devcontainer
      • 2️⃣ Setting Up Devcontainer
  • πŸ“š Examples
    • 🌟 Generic Usage
      • πŸ” Hub Mode Example
      • πŸ“¦ Hub Project Demo
  • πŸ”§ API Reference
    • Main Module
  • πŸš€ Getting Started
    • πŸ“¦ Installation
    • ⚑ Quick Start
    • πŸ“– Complete Getting Started Guide
    • πŸ—οΈ Hub Architecture
Back to top
View this page

πŸ’‘ Link ExamplesΒΆ

Real-world link conversion examples

Example 1: Documentation HomepageΒΆ

Input MarkdownΒΆ

# MyProject Documentation

![Project Logo](../images/logo.png)

## Quick Start

Welcome! Follow these steps:

1. Review [system requirements](./requirements.md#minimum-specs)
2. Follow [installation instructions](./install.md#quick-install)
3. Complete [initial configuration](./config.md#basic-setup)
4. Read the [user guide](./guide.md)

## External Resources

- [Official Website](https://myproject.org/)
- [API Documentation](https://api.myproject.org/)
- [GitHub Repository](https://github.com/myproject/repo)
- [Community Forum](https://forum.myproject.org/)

## Need Help?

Check our [troubleshooting guide](./troubleshooting.md#common-issues) or
visit the [support page](https://myproject.org/support).

Generated RSTΒΆ

MyProject Documentation
=======================


.. image:: ../images/logo.png
   :alt: Project Logo



Quick Start
-----------

Welcome! Follow these steps:

1. Review :doc:`system requirements (Minimum Specs) <requirements>`
2. Follow :doc:`installation instructions (Quick Install) <install>`
3. Complete :doc:`initial configuration (Basic Setup) <config>`
4. Read the :doc:`user guide <guide>`


External Resources
------------------

- `Official Website <https://myproject.org/>`_
- `API Documentation <https://api.myproject.org/>`_
- `GitHub Repository <https://github.com/myproject/repo>`_
- `Community Forum <https://forum.myproject.org/>`_


Need Help?
----------

Check our :doc:`troubleshooting guide (Common Issues) <troubleshooting>` or
visit the `support page <https://myproject.org/support>`_.

Example 2: Installation GuideΒΆ

Input MarkdownΒΆ

# Installation Guide

## Prerequisites

Before installing, ensure you have:

1. Python 3.8 or higher
2. Docker installed ([installation guide](https://docs.docker.com/get-docker/))
3. Git configured

See the [system requirements](./requirements.md) for complete details.

## Quick Installation

For most users, quick installation is recommended.

![Installation Flow](./diagrams/install-flow.png)

Run these commands:

pip install myproject myproject init

For troubleshooting, see the [common issues](#common-issues) section below.

## Advanced Installation

For advanced configuration, refer to the [configuration guide](./config.md#advanced-options).

## Common Issues

Having problems? Check the [FAQ](./faq.md) or the [troubleshooting guide](./troubleshooting.md#installation).

Generated RSTΒΆ

Installation Guide
==================


Prerequisites
-------------

Before installing, ensure you have:

1. Python 3.8 or higher
2. Docker installed (`installation guide <https://docs.docker.com/get-docker/>`_)
3. Git configured

See the :doc:`system requirements <requirements>` for complete details.


Quick Installation
------------------

For most users, quick installation is recommended.


.. image:: ./diagrams/install-flow.png
   :alt: Installation Flow


Run these commands:

.. code-block:: bash

   pip install myproject
   myproject init


For troubleshooting, see the :ref:`common-issues` section below.


Advanced Installation
---------------------

For advanced configuration, refer to the :doc:`configuration guide (Advanced Options) <config>`.


Common Issues
-------------

Having problems? Check the :doc:`FAQ <faq>` or the :doc:`troubleshooting guide (Installation) <troubleshooting>`.

Example 3: API DocumentationΒΆ

Input MarkdownΒΆ

# API Reference

Complete API documentation for developers.

## Getting Started with the API

Read the [authentication guide](./auth.md#api-keys) to get your API key.

## Core APIs

### User Management
- [Create User](./api/users.md#create-user)
- [Get User](./api/users.md#get-user)
- [Update User](./api/users.md#update-user)

### Data Operations
- [Query Data](./api/data.md#query-operations)
- [Insert Data](./api/data.md#insert-operations)
- [Update Data](./api/data.md#update-operations)

## External Tools

Recommended tools for API development:

- [Postman](https://www.postman.com/) - API testing
- [Swagger UI](https://swagger.io/tools/swagger-ui/) - API visualization
- [curl](https://curl.se/) - Command-line HTTP client

## Code Examples

For Python examples, see the [Python SDK guide](./sdks/python.md#quick-start).

![API Architecture](./diagrams/api-architecture.png)

Generated RSTΒΆ

API Reference
=============

Complete API documentation for developers.


Getting Started with the API
-----------------------------

Read the :doc:`authentication guide (Api Keys) <auth>` to get your API key.


Core APIs
---------


User Management
~~~~~~~~~~~~~~~
- :doc:`Create User (Create User) <api/users>`
- :doc:`Get User (Get User) <api/users>`
- :doc:`Update User (Update User) <api/users>`


Data Operations
~~~~~~~~~~~~~~~
- :doc:`Query Data (Query Operations) <api/data>`
- :doc:`Insert Data (Insert Operations) <api/data>`
- :doc:`Update Data (Update Operations) <api/data>`


External Tools
--------------

Recommended tools for API development:

- `Postman <https://www.postman.com/>`_ - API testing
- `Swagger UI <https://swagger.io/tools/swagger-ui/>`_ - API visualization
- `curl <https://curl.se/>`_ - Command-line HTTP client


Code Examples
-------------

For Python examples, see the :doc:`Python SDK guide (Quick Start) <sdks/python>`.


.. image:: ./diagrams/api-architecture.png
   :alt: API Architecture

Example 4: Tutorial with NavigationΒΆ

Input MarkdownΒΆ

# Getting Started Tutorial

Welcome! This tutorial will guide you through the basics.

## Table of Contents

- [Installation](#installation)
- [Configuration](#configuration)
- [First Steps](#first-steps)
- [Next Steps](#next-steps)

## Installation

![Installation Steps](./images/install-steps.png)

Follow the [installation guide](./install.md#quick-install) to set up.

## Configuration

After installation, configure your environment:

1. Copy the [example config](./config.md#example-configuration)
2. Update [API settings](./config.md#api-configuration)
3. Test with [sample data](./examples.md#sample-datasets)

## First Steps

Now that you're set up, try these examples:

- [Hello World](./examples.md#hello-world-example)
- [Data Processing](./examples.md#data-processing)
- [Advanced Usage](./advanced.md#getting-started)

## Next Steps

Continue learning:

- Read the [user guide](./guide.md)
- Explore [advanced features](./advanced.md)
- Check [best practices](./best-practices.md)
- Join our [community forum](https://forum.example.com/)

For help, see the [FAQ](#faq) below.

## FAQ

Common questions and answers...

Generated RSTΒΆ

Getting Started Tutorial
========================

Welcome! This tutorial will guide you through the basics.


Table of Contents
-----------------

- :ref:`installation`
- :ref:`configuration`
- :ref:`first-steps`
- :ref:`next-steps`


Installation
------------


.. image:: ./images/install-steps.png
   :alt: Installation Steps


Follow the :doc:`installation guide (Quick Install) <install>` to set up.


Configuration
-------------

After installation, configure your environment:

1. Copy the :doc:`example config (Example Configuration) <config>`
2. Update :doc:`API settings (Api Configuration) <config>`
3. Test with :doc:`sample data (Sample Datasets) <examples>`


First Steps
-----------

Now that you're set up, try these examples:

- :doc:`Hello World (Hello World Example) <examples>`
- :doc:`Data Processing (Data Processing) <examples>`
- :doc:`Advanced Usage (Getting Started) <advanced>`


Next Steps
----------

Continue learning:

- Read the :doc:`user guide <guide>`
- Explore :doc:`advanced features <advanced>`
- Check :doc:`best practices <best-practices>`
- Join our `community forum <https://forum.example.com/>`_

For help, see the :ref:`faq` below.


FAQ
---

Common questions and answers...

Example 5: Cheat Sheet DocumentΒΆ

Input MarkdownΒΆ

# Quick Reference

## Common Commands

For detailed explanations, see the [command reference](./commands.md).

### Basic Commands
- `init` - [Initialize project](./commands.md#init-command)
- `run` - [Run application](./commands.md#run-command)
- `test` - [Run tests](./commands.md#test-command)

### Advanced Commands
- `deploy` - [Deploy application](./commands.md#deploy-command)
- `config` - [Manage configuration](./commands.md#config-command)

## Configuration Files

Configuration documentation:
- [Main config](./config.md#main-configuration)
- [Environment variables](./config.md#environment-vars)
- [Logging setup](./config.md#logging-configuration)

## External Documentation

- [Python Docs](https://docs.python.org/)
- [Docker Docs](https://docs.docker.com/)
- [Kubernetes Docs](https://kubernetes.io/docs/)

Back to [main documentation](#).

Generated RSTΒΆ

Quick Reference
===============


Common Commands
---------------

For detailed explanations, see the :doc:`command reference <commands>`.


Basic Commands
~~~~~~~~~~~~~~
- `init` - :doc:`Initialize project (Init Command) <commands>`
- `run` - :doc:`Run application (Run Command) <commands>`
- `test` - :doc:`Run tests (Test Command) <commands>`


Advanced Commands
~~~~~~~~~~~~~~~~~
- `deploy` - :doc:`Deploy application (Deploy Command) <commands>`
- `config` - :doc:`Manage configuration (Config Command) <commands>`


Configuration Files
-------------------

Configuration documentation:
- :doc:`Main config (Main Configuration) <config>`
- :doc:`Environment variables (Environment Vars) <config>`
- :doc:`Logging setup (Logging Configuration) <config>`


External Documentation
----------------------

- `Python Docs <https://docs.python.org/>`_
- `Docker Docs <https://docs.docker.com/>`_
- `Kubernetes Docs <https://kubernetes.io/docs/>`_

Back to :ref:`main documentation <#>`.

Common Patterns SummaryΒΆ

Pattern 1: Navigation LinksΒΆ

- [Guide](./guide.md)
- [API](./api.md)

Pattern 2: Links with SectionsΒΆ

- [Installation](./install.md#prerequisites)
- [Config](./config.md#basic-setup)

Pattern 3: External ResourcesΒΆ

- [Website](https://example.com/)
- [GitHub](https://github.com/project)

Pattern 4: Same-Page NavigationΒΆ

- [Installation](#installation)
- [Configuration](#configuration)

Pattern 5: ImagesΒΆ

![Diagram](./diagram.png)

Key TakeawaysΒΆ

βœ… All link types are automatically converted βœ… Section names are added to link text βœ… Images become RST directives βœ… External links work perfectly βœ… Zero manual conversion needed

Just write markdown naturally, and Introligo handles the conversion!

Next
πŸ–ΌοΈ Working with Images
Previous
πŸ”— Link Conversion
Copyright © 2025, WT Tech Jakub Brzezowski
Made with Sphinx and @pradyunsg's Furo
On this page
  • πŸ’‘ Link Examples
    • Example 1: Documentation Homepage
      • Input Markdown
      • Generated RST
    • Example 2: Installation Guide
      • Input Markdown
      • Generated RST
    • Example 3: API Documentation
      • Input Markdown
      • Generated RST
    • Example 4: Tutorial with Navigation
      • Input Markdown
      • Generated RST
    • Example 5: Cheat Sheet Document
      • Input Markdown
      • Generated RST
    • Common Patterns Summary
      • Pattern 1: Navigation Links
      • Pattern 2: Links with Sections
      • Pattern 3: External Resources
      • Pattern 4: Same-Page Navigation
      • Pattern 5: Images
    • Key Takeaways