From ea692e8fa3f8876c3e47f3c280d585eb8e62c8a1 Mon Sep 17 00:00:00 2001 From: Michael Chris Lopez Date: Thu, 28 Oct 2021 06:16:31 +0800 Subject: [PATCH] doc: cleanup --- .github/workflows/doc.yml | 6 ++++++ doc/zenbones.md | 8 ++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index d1ae9f1..0f7e08c 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -8,6 +8,12 @@ jobs: vimdocgen: runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: - uses: actions/checkout@v2 - name: Setup git diff --git a/doc/zenbones.md b/doc/zenbones.md index bb49e3b..07f9c0b 100644 --- a/doc/zenbones.md +++ b/doc/zenbones.md @@ -31,11 +31,13 @@ Configuration is only available for neovim. There are two ways to set configuration. First: ```vim +" vimscript let g:zenbones_solid_line_nr = v:true let g:zenbones_darken_comments = 45 ``` ```lua +-- lua vim.g.zenbones_solid_line_nr = true vim.g.zenbones_darken_comments = 45 ``` @@ -43,10 +45,12 @@ vim.g.zenbones_darken_comments = 45 Second way is to set configuration is to assign a dictionary to the prefix: ```vim +" vimscript let g:forestbones = #{ solid_line_nr: v:true, darken_comments: 45 } ``` ```lua +-- lua vim.g.forestbones = { solid_line_nr = true, darken_comments = 45 } ``` @@ -54,7 +58,7 @@ vim.g.forestbones = { solid_line_nr = true, darken_comments = 45 } the flavor name e.g. `g:rosebones_italic_comments`. | Option | Background | Default | Description | -| :------------------------ | :--------- | :------ | :------------------------------------------------------------------------------------------ | +| ------------------------- | ---------- | ------- | ------------------------------------------------------------------------------------------- | | lightness | light | `nil` | Change background colors lightness. Options: `'bright'`, `'dim'`. | | darkness | dark | `nil` | Change background colors darkness. Options: `'stark'`, `'warm'`. | | solid_vert_split | both | `false` | Solid \|hl-VertSplit\| background. | @@ -72,7 +76,7 @@ the flavor name e.g. `g:rosebones_italic_comments`. #### g:zenbones_compat -Set to `1` to turn on compatibility mode. +Set to `1` to turn on compatibility mode. Turned on in vim. #### lightline