Skip to content

Commit

Permalink
docs(readme): add papis_conf_keys option
Browse files Browse the repository at this point in the history
and some misc improvements
  • Loading branch information
jghauser committed Jun 4, 2024
1 parent 4e4b855 commit 906154b
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ You'll need the [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) plugin if you in
In addition to the below snippets, make sure to also install the *treesitter yaml parser* if you intend to use the completion module.

<details>
<summary>rocks.nvim configuration</summary>
<summary>rocks.nvim</summary>

```vim
:Rocks install papis.nvim
Expand All @@ -87,7 +87,7 @@ In addition to the below snippets, make sure to also install the *treesitter yam
</details>

<details>
<summary>lazy.nvim configuration</summary>
<summary>lazy.nvim</summary>

```lua
{
Expand All @@ -108,7 +108,7 @@ In addition to the below snippets, make sure to also install the *treesitter yam
</details>

<details>
<summary>packer configuration</summary>
<summary>packer</summary>

```lua
use({
Expand Down Expand Up @@ -178,8 +178,10 @@ Minimal setup:

```lua
require("papis").setup({
-- Enable the default keymaps
-- Enable the default keymaps (defaults to `false`)
enable_keymaps = true,
-- You might want to change the filetypes activating papis.nvim
-- init_filetypes = { "markdown", "norg", "yaml" },
})
```

Expand Down Expand Up @@ -259,7 +261,7 @@ db_path = vim.fn.stdpath("data") .. "/papis_db/papis-nvim.sqlite3",
yq_bin = "yq",

-- Function to execute when adding a new note. `ref` is the citation key of the
-- relevant entry and `notes_name` is defined in `papis_python` above.
-- relevant entry and `notes_name` is the name of the notes file.
create_new_note_fn = function(papis_id, notes_name)
vim.fn.system(
string.format(
Expand All @@ -273,6 +275,9 @@ end,
-- Filetypes that start papis.nvim.
init_filetypes = { "markdown", "norg", "yaml" },

-- Papis options to import into papis.nvim.
papis_conf_keys = { "info-name", "notes-name", "dir", "opentool" },

-- Configuration of the search module.
["search"] = {

Expand Down

0 comments on commit 906154b

Please sign in to comment.