language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-10-03 15:14:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

doc: Fix links to language specific reference docs in Slint reference

Browse source 
Instead of linking to the latest /docs/cpp, etc., link to /releases/XXX/docs/cpp.

(Converted the getting started to markdown while at it )
This commit is contained in:
Simon Hausmann 2023-08-30 14:55:09 +02:00
parent f328b394f8
commit d0fbb3e1a4
4 changed files with 32 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/reference/conf.py
View file

@ -95,6 +95,13 @@ myst_enable_extensions = [
"html_image", "html_image",
] ]
myst_url_schemes = {
"slint-cpp": f"https://slint.dev/releases/{version}/docs/cpp/{{{{path}}}}",
"slint-rust": f"https://slint.dev/releases/{version}/docs/rust/slint/{{{{path}}}}",
"slint-node": f"https://slint.dev/releases/{version}/docs/node/{{{{path}}}}",
'http': None, 'https': None, 'mailto': None,
}
# Annotate h1/h2 elements with anchors # Annotate h1/h2 elements with anchors
myst_heading_anchors = 4 myst_heading_anchors = 4

3
docs/reference/index.rst
View file

@ -1,7 +1,8 @@
.. Copyright © SixtyFPS GmbH <info@slint.dev> .. Copyright © SixtyFPS GmbH <info@slint.dev>
.. SPDX-License-Identifier: MIT .. SPDX-License-Identifier: MIT
.. include:: src/introduction/index.rst .. include:: src/introduction/index.md
:parser: myst_parser.sphinx_
.. toctree:: .. toctree::
:hidden: :hidden:

23
docs/reference/src/introduction/index.md Normal file
View file

@ -0,0 +1,23 @@
<!-- Copyright © SixtyFPS GmbH <info@slint.dev> ; SPDX-License-Identifier: MIT -->
# Getting Started
First, you need `.slint` files, which contain a textual description of your user interface, written in the Slint language.
Next, you embed the `.slint` files in a project written in a supported programming language, like C++, Rust, or JavaScript.
There are three different pathways to get started with Slint:
1. [SlintPad](https://slint.dev/editor) - Use this to get a feel of the Slint language.
This is a web browser-based tool where you can try Slint out.
2. As a UI Designer, working with Slint files locally, we recommend the following combination of software tools:
- [Visual Studio Code](https://code.visualstudio.com)
- [The Slint for Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=Slint.slint)
3. As a Software Developer, integrating Slint into a new or existing code base, choose one of these languages to
get started:
- [C++](slint-cpp:index.html)
- [Rust](slint-rust:index.html)
- [JavaScript](slint-node:index.html)

25
docs/reference/src/introduction/index.rst
View file

@ -1,25 +0,0 @@
.. Copyright © SixtyFPS GmbH <info@slint.dev>
.. SPDX-License-Identifier: MIT
Getting Started
===============
First, you need :code:`.slint` files, which contain a textual description of your user interface, written in the Slint language.
Next, you embed the :code:`.slint` files in a project written in a supported programming language, like C++, Rust, or JavaScript.
There are three different pathways to get started with Slint:
1. `SlintPad <https://slint.dev/editor>`_ - Use this to get a feel of the Slint language.
This is a web browser-based tool where you can try Slint out.
2. As a UI Designer, working with Slint files locally, we recommend the following combination of software tools:
- `Visual Studio Code <https://code.visualstudio.com>`_
- `The Slint for Visual Studio Code Extension <https://marketplace.visualstudio.com/items?itemName=Slint.slint>`_
3. As a Software Developer, integrating Slint into a new or existing code base, choose one of these languages to
get started:
- `C++ <https://slint.dev/docs/cpp/>`_
- `Rust <https://slint.dev/docs/rust/slint/>`_
- `JavaScript <https://slint.dev/docs/node/>`_