[gtksourceview: 10/21] docs: port the intro to markdown




commit c80dbe30c9d500aa1d249855e3172b01db6c3821
Author: Bilal Elmoussaoui <bil elmoussaoui gmail com>
Date:   Tue Nov 30 19:08:18 2021 +0100

    docs: port the intro to markdown

 docs/GtkSource.toml.in      |  1 +
 docs/overview.md            | 24 ++++++++++++++++++++++++
 docs/reference/intro.xml.in | 41 -----------------------------------------
 docs/reference/meson.build  |  6 ------
 4 files changed, 25 insertions(+), 47 deletions(-)
---
diff --git a/docs/GtkSource.toml.in b/docs/GtkSource.toml.in
index 7510f59f..81f823b1 100644
--- a/docs/GtkSource.toml.in
+++ b/docs/GtkSource.toml.in
@@ -55,6 +55,7 @@ show_class_hierarchy = true
 [extra]
 # The same order will be used when generating the index
 content_files = [
+  "overview.md",
   "lang-tutorial.md",
   "porting-guide-3-to-4.md",
   "porting-guide-4-to-5.md",
diff --git a/docs/overview.md b/docs/overview.md
new file mode 100644
index 00000000..bec5cd09
--- /dev/null
+++ b/docs/overview.md
@@ -0,0 +1,24 @@
+Title: Overview
+
+# Overview
+
+GtkSourceView is a [GNOME](https://www.gnome.org/) library
+that extends GtkTextView, the standard GTK+ widget for multiline text
+editing. GtkSourceView adds support for syntax highlighting, undo/redo, file
+loading and saving, search and replace, a completion system, printing,
+displaying line numbers, and other features typical of a source code editor.
+
+See the [GtkSourceView website](https://wiki.gnome.org/Projects/GtkSourceView).
+
+GtkSourceView 5 depends on GTK 4.
+
+## pkg-config name
+
+For GtkSourceView 5, the pkg-config name is: `gtksourceview-5`
+
+To compile a program that uses GtkSourceView 5, you
+can for example use the following command:
+
+```
+$ gcc hello.c `pkg-config --cflags --libs gtksourceview-5` -o hello
+```
diff --git a/docs/reference/meson.build b/docs/reference/meson.build
index 77c2d1c3..18dc5df0 100644
--- a/docs/reference/meson.build
+++ b/docs/reference/meson.build
@@ -69,11 +69,6 @@ reference_sources = [
   join_paths(builddir, 'gtksourceview'),
 ]
 
-into_xml = configure_file(
-         input: 'intro.xml.in',
-         output: 'intro.xml',
-  configuration: config_h
-)
 
 lang_reference_xml = configure_file(
           input: 'lang-reference.xml.in',
@@ -94,7 +89,6 @@ style_reference_xml = configure_file(
 )
 
 reference_content_files += [
-  into_xml,
   lang_reference_xml,
   style_reference_xml,
 ]


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]