Skip to content

Commit

Permalink
feat: added README file
Browse files Browse the repository at this point in the history
  • Loading branch information
JanssenBrm committed May 7, 2024
1 parent 1a51001 commit 5cc7b4f
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
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.

0 comments on commit 5cc7b4f

Please sign in to comment.