Skip to content

Commit

Permalink
chore(docs): auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh authored and github-actions[bot] committed Nov 30, 2023
1 parent 80c45c1 commit 6a7e9a3
Showing 1 changed file with 40 additions and 3 deletions.
43 changes: 40 additions & 3 deletions doc/pomo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Lua.
- 🪶 Lightweight and asynchronous
- 💻 Written in Lua
- ⚙️ Easily customizable and extendable
- ⏱️ Supports multiple concurrent timers
- ⏱️ Run multiple concurrent timers
- ➕ Integrate with |pomo-lualine|


COMMANDS *pomo-commands*
Expand Down Expand Up @@ -162,7 +163,43 @@ following entry:


==============================================================================
5. Contributing *pomo-contributing*
5. Integrations *pomo-integrations*


LUALINE.NVIM *pomo-lualine.nvim*

pomo.nvim can easily be added to a section in lualine. For example, this would
extend the defaults for section X to include the next timer to finish (min time
remaining):

>lua
require("lualine").setup {
sections = {
lualine_x = {
function()
local ok, pomo = pcall(require, "pomo")
if not ok then
return ""
end

local timer = pomo.get_first_to_finish()
if timer == nil then
return ""
end

return "󰄉 " .. tostring(timer)
end,
"encoding",
"fileformat",
"filetype",
},
},
}
<


==============================================================================
6. Contributing *pomo-contributing*

Please see the CONTRIBUTING
<https://github.com/epwalsh/obsidian.nvim/blob/main/.github/CONTRIBUTING.md>
Expand All @@ -176,7 +213,7 @@ funds! ❤️
<https://www.buymeacoffee.com/epwalsh>

==============================================================================
6. Links *pomo-links*
7. Links *pomo-links*

1. *demo-gif*: https://github.com/epwalsh/pomo.nvim/assets/8812459/e987203c-6e00-4e04-9012-2a1202953dab
2. *BuyMeACoffee*: https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black
Expand Down

0 comments on commit 6a7e9a3

Please sign in to comment.