@tobi-or-not/docpress 0.8.3 → 0.9.0

package/README.md

@@ -1,10 +1,10 @@
 # Docpress :zap:
 
-This project aims to automate the construction of documentation website based on a Github username and optionally a list of repositories.
+This project aims to automate the construction of documentation website based on a GitHub or GitLab username and optionally a list of repositories.
 
 ## Explanation
 
-Docpress automates the process of downloading documentation files from specified GitHub repositories. Here's how it works:
+Docpress automates the process of downloading documentation files from specified GitHub or GitLab repositories. Here's how it works:
 
 1. __Repository Documentation Retrieval__:
     - The program checks if a `docs/` folder is present at the root level of each specified repository.
@@ -30,7 +30,7 @@ __Table of Contents__ *- md sources*:
 1. Generate website using the Docpress docker image.
     ```sh
     docker run --name docpress --rm -v $(pwd)/docpress:/app/docpress:rw \
-      ghcr.io/this-is-tobi/docpress -U <github_username>
+      ghcr.io/this-is-tobi/docpress -U <username>
     ```
     > The dist folder is available at `./docpress/.vitepress/dist`, ready to be served by a web server like Nginx, Apache, etc...
 
@@ -56,7 +56,9 @@ Options:
   -c, --extra-public-content <string>  List of comma separated additional files or directories to process Vitepress public folder.
   -C, --config <string>                Path to the docpress configuration file.
   -f, --forks                          Whether or not to create the dedicated fork page that aggregate external contributions.
-  -g, --git-provider <string>          Git provider used to retrieve data. Values should be "github". (default: "github")
+  -g, --git-provider <string>          Git provider used to retrieve data.
+                                       Values should be "github" or "gitlab".
+                                       (default: "github")
   -h, --help                           display help for command
   -p, --extra-header-pages <string>    List of comma separated additional files or directories to process Vitepress header pages.
   -r, --repos-filter <string>          List of comma separated repositories to retrieve from Git provider. Default to all user's public repositories.
@@ -84,7 +86,7 @@ If you prefer Node.js package managers like npm, pnpm, or bun, you can easily in
 
 To run Docpress using npm:
 ```sh
-npx @tobi-or-not/docpress -U <github_username>
+npx @tobi-or-not/docpress -U <username>
 ```
 
 > [!TIP]
@@ -96,7 +98,7 @@ Docpress also provides a Docker image, which is especially useful if you want to
 
 To run Docpress with Docker:
 ```sh
-docker run --rm -v $(pwd)/docpress:/app/docpress:rw ghcr.io/this-is-tobi/docpress -U <github_username>
+docker run --rm -v $(pwd)/docpress:/app/docpress:rw ghcr.io/this-is-tobi/docpress -U <username>
 ```
 
 In this command:
@@ -127,12 +129,12 @@ To ensure that the program functions correctly, please follow these conventions:
 
 ### Link management
 
-- Any inline link in the `./README.md` file that does not point to `./docs/**` will be replaced with the corresponding GitHub link.
-- Similarly, any inline link in the `./docs/*.md` files that does not reference `./docs/**` will also be replaced with the appropriate GitHub link.
+- Any inline link in the `./README.md` file that does not point to `./docs/**` will be replaced with the corresponding Git provider link.
+- Similarly, any inline link in the `./docs/*.md` files that does not reference `./docs/**` will also be replaced with the appropriate Git provider link.
 
 ### Project descriptions
 
-- The project description displayed on the home page of the generated website is extracted from the GitHub repository's description.
+- The project description displayed on the home page of the generated website is extracted from the repository's description on the Git provider.
 
 ---