docs: update dashboard docs

2giosangmitom · Jun 11, 2024 · 2535851 · 2535851
1 parent d6f369d
commit 2535851
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/doc/nightfall.nvim.txt b/doc/nightfall.nvim.txt
@@ -268,7 +268,11 @@ integrations config:
 <
 
 ------------------------------------------------------------------------------
-Parameters ~
-{colors} NightfallPalette
+                                                      *nightfall.nvim_dashboard*
+Enable `dashboard-nvim` support by adding the following to your Nightfall
+integrations config:
+>lua
+  dashboard = { enabled = true }
+<
 
  vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/lua/nightfall/themes/integrations/dashboard.lua b/lua/nightfall/themes/integrations/dashboard.lua
@@ -1,6 +1,14 @@
+--- Enable `dashboard-nvim` support by adding the following to your Nightfall
+--- integrations config:
+--- >lua
+---   dashboard = { enabled = true }
+--- <
+---@tag nightfall.nvim_dashboard
+
 local M = {}
 
 ---@param colors NightfallPalette
+---@private
 function M.get(colors)
   return {
     DashboardShortCut = { fg = colors.violet },