Merge pull request #49 from linkwarden/dev

Dev

Author: daniel31x13

.github/workflows/deploy.yml

@@ -21,6 +21,8 @@ jobs:
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
+      - name: Generate OpenAPI docs
+        run: yarn docusaurus gen-api-docs all
       - name: Build website
         run: yarn build
       - name: Deploy to GitHub Pages

.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 .docusaurus
 .cache-loader
+/docs/api
 
 # Misc
 .DS_Store

README.md

@@ -24,6 +24,14 @@ $ yarn build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
+### Generate OpenAPI pages
+
+```
+yarn docusaurus gen-api-docs all
+```
+
+This command generates API docs for the OpenAPI YAML file in the `openapi` directory. The generated pages are placed in the `docs/openapi` directory.
+
 ### Deployment
 
 Using SSH:

docs/api/_category_.json

@@ -71,7 +71,7 @@ After a few minutes (depending on your internet connection) you can access Linkw
 
 :::note
 
-The Manual Installation is targeted towards a more technical audience, to take an easier path, go for installation using [Docker](/self-hosting/installation#docker-).
+The Manual Installation is targeted towards a more technical audience, to take an easier path, go for installation using [Docker](/self-hosting/installation#docker-compose).
 
 :::
 

docs/api/overview.md

@@ -50,7 +50,7 @@ If you did the [Manual installation](/self-hosting/installation#manual-installat
 node scripts/migration/migrateToV2.js
 ```
 
-For [Docker](/self-hosting/installation#docker-) users, replace `CONTAINER_ID` with your running Linkwarden container's ID and execute the following command:
+For [Docker](/self-hosting/installation#docker-compose) users, replace `CONTAINER_ID` with your running Linkwarden container's ID and execute the following command:
 
 ```
 docker exec -it CONTAINER_ID /bin/bash -c 'node scripts/migration/migrateToV2.js'

docs/self-hosting/installation.md

@@ -0,0 +1,13 @@
+// This is used to exclude the openapi sidebar item from the autogenerated sidebar
+// docusaurus creates so we can use the generated sidebar that docusaurus-plugin-openapi-docs creates
+// which automatically groups the endpoints by tag
+async function customSidebarItemsGenerator({
+  defaultSidebarItemsGenerator,
+  ...args
+}) {
+  const sidebarItems = await defaultSidebarItemsGenerator(args);
+
+  return sidebarItems.filter((item) => item.label !== "api");
+}
+
+export default customSidebarItemsGenerator;