-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1a51001
commit 5cc7b4f
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Welcome to the APEx documentation portal | ||
|
||
This GitHub repository manages the content of the APEx documentation portal. | ||
The generation of the content is based on [Quarto](https://quarto.org/). | ||
If you want to preview the content and your changes, it is important to install the Quarto CLI before edidt | ||
Once this has been completed you can preview the content by running the following command: | ||
|
||
```bash | ||
quarto preview . | ||
``` | ||
|
||
# Welcome to the APEx documentation portal | ||
|
||
This GitHub repository serves as the central hub for managing the APEx documentation portal. | ||
The content generation is facilitated by [Quarto](https://quarto.org/), an open-source scientific and technical publishing system. | ||
|
||
To preview the content and any changes you make, it's crucial to install the Quarto CLI beforehand. | ||
Once installed, you can preview the content by running the following command in your terminal: | ||
|
||
```bash | ||
quarto preview . | ||
``` | ||
|
||
This command will initiate a local preview of the documentation portal, allowing you to review your changes before committing them. |