Merge pull request #113 from ggrossetie/asciidoc-fix

Move attributes to module and fix a few AsciiDoc syntax errors
feelpp · Sep 13, 2023 · 4f479a3 · 4f479a3
2 parents 0e00aec + 000bfc2
commit 4f479a3
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 19 deletions.
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -5,6 +5,13 @@ start_page: index.adoc
 asciidoc:
   attributes:
     project_name: Feel++ Template Project
+    numbered: true
+    allow-uri-read: true
+    hide-uri-scheme: true
+    stem: latexmath
+    python: Python
+    cpp: C++
+    feelpp: Feel++
 ext:
   collector:
     - run:

diff --git a/docs/modules/ROOT/pages/env/antora.adoc b/docs/modules/ROOT/pages/env/antora.adoc
@@ -2,7 +2,7 @@
 
 Antora is our static website generator. 
 We use it to generate the documentation of the project 
-It is part of the documentation of docs.feelpp.org[{feelpp} docs] website.
+It is part of the documentation of https://docs.feelpp.org[{feelpp} docs] website.
 
 .To generate the documentation
 [source,shell]
@@ -13,6 +13,4 @@ It is part of the documentation of docs.feelpp.org[{feelpp} docs] website.
 ----
 <1> Install the dependencies
 <2> Generate the documentation
-<3> Serve the documentation, the url is provided in the console
-
-include::antora-ui::partial$antora.adoc[leveloffset=+1]
+<3> Serve the documentation, the URL is provided in the console
diff --git a/docs/modules/ROOT/pages/env/rename.adoc b/docs/modules/ROOT/pages/env/rename.adoc
@@ -2,4 +2,4 @@
 
 The script `rename.sh` renames the project. 
 
-You have to answer a few questions to setup a new project out of this template.
+You have to answer a few questions to set up a new project out of this template.
diff --git a/docs/modules/ROOT/pages/overview.adoc b/docs/modules/ROOT/pages/overview.adoc
@@ -20,7 +20,7 @@ The directory structure of the project is as follows:
 [NOTE]
 ====
 {feelpp} is a {cpp} library for the numerical simulation of partial differential equations. It is designed to be easy to use and to extend.
-{feelpp }is a free software distributed under the terms of the GNU General Public License version 3.
+{feelpp} is a free software distributed under the terms of the GNU General Public License version 3.
 The documentation is available https://docs.feelpp.org[> here].
 ====
 

diff --git a/docs/modules/ROOT/pages/quickstart.adoc b/docs/modules/ROOT/pages/quickstart.adoc
@@ -18,10 +18,10 @@ Please ensure that you have https://code.visualstudio.com/[Visual Studio Code] a
 
 To start using DevContainers in Visual Studio Code, follow these steps:
 
-1. Open your project in Visual Studio Code.
-2. A `devcontainer.json` file in the root of your project in `.devcontainer` directory
-3. A configuration similar to the following one is available:
-
+. Open your project in Visual Studio Code.
+. A `devcontainer.json` file in the root of your project in `.devcontainer` directory
+. A configuration similar to the following one is available:
++
 [source,json]
 ----
 {
@@ -38,16 +38,18 @@ To start using DevContainers in Visual Studio Code, follow these steps:
 }
 ----
 
-4. Customize the configuration based on your project requirements. In the example above, the configuration sets the name of the Dev Container as "Feel++ Dev Jammy" and specifies the Docker image to use as "ghcr.io/feelpp/feelpp-dev:jammy". Additionally, it includes a list of extensions to install inside the Dev Container.
+. Customize the configuration based on your project requirements.
+In the example above, the configuration sets the name of the Dev Container as "Feel++ Dev Jammy" and specifies the Docker image to use as "ghcr.io/feelpp/feelpp-dev:jammy".
+Additionally, it includes a list of extensions to install inside the Dev Container.
 
 === Opening in DevContainer
 
 To open your project using the DevContainer, follow these steps:
 
-1. Open the Command Palette in Visual Studio Code by pressing `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS).
-2. Search for and select "Remote-Containers: Reopen in Container".
-3. Visual Studio Code will build the Docker image specified in the `devcontainer.json` file and open a new window inside the Dev Container.
-4. Once the Dev Container is loaded, you can start working on your project within the containerized environment.
+. Open the Command Palette in Visual Studio Code by pressing `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS).
+. Search for and select "Remote-Containers: Reopen in Container".
+. Visual Studio Code will build the Docker image specified in the `devcontainer.json` file and open a new window inside the Dev Container.
+. Once the Dev Container is loaded, you can start working on your project within the containerized environment.
 
 === Benefits of Using DevContainers
 
@@ -57,7 +59,4 @@ Using DevContainers in Visual Studio Code offers several benefits:
 - **Isolation and Dependency Management**: DevContainers isolate your project dependencies from your local machine, reducing conflicts and simplifying dependency management.
 - **Easy Extension Installation**: DevContainers automatically install the specified extensions, making it easy to set up the required tools and configurations for your project.
 
-[NOTE]
-====
-Make sure your Docker daemon is running and accessible from the terminal to use DevContainers in Visual Studio Code.
-====
+NOTE: Make sure your Docker daemon is running and accessible from the terminal to use DevContainers in Visual Studio Code.