From 3bb832c9c4e50c129ce7a546c031c0f60b54e3a5 Mon Sep 17 00:00:00 2001 From: backdround Date: Wed, 1 Nov 2023 20:14:39 +0300 Subject: [PATCH] docs: Update documentation (#58) --- README.md | 4 ++-- action.yaml | 2 +- doc/panvimdoc.txt | 4 ++-- panvimdoc.sh | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 54a5215..9edaad1 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ jobs: pandoc: "README.md" # Input pandoc file version: "NVIM v0.8.0" # Vim version number toc: true # Table of contents - description: "" # Project Description + description: "" # Project description used in title (if empty, uses neovim version and current date) demojify: false # Strip emojis from the vimdoc dedupsubheadings: true # Add heading to subheading anchor links to ensure that subheadings are unique treesitter: true # Use treesitter for highlighting codeblocks @@ -183,7 +183,7 @@ Arguments: --input-file: the input markdown file --vim-version: the version of Vim that the project is compatible with --toc: 'true' if the output should include a table of contents, 'false' otherwise - --description: a description of the project + --description: a project description used in title (if empty, uses neovim version and current date) --dedup-subheadings: 'true' if duplicate subheadings should be removed, 'false' otherwise --demojify: 'false' if emojis should not be removed, 'true' otherwise --treesitter: 'true' if the project uses Tree-sitter syntax highlighting, 'false' otherwise diff --git a/action.yaml b/action.yaml index e295ac5..319d393 100644 --- a/action.yaml +++ b/action.yaml @@ -21,7 +21,7 @@ inputs: required: false default: "true" description: - description: "Project description" + description: "Project description used in title (if empty, uses neovim version and current date)" required: false default: "" demojify: diff --git a/doc/panvimdoc.txt b/doc/panvimdoc.txt index 7b439d6..c2f1c72 100644 --- a/doc/panvimdoc.txt +++ b/doc/panvimdoc.txt @@ -136,7 +136,7 @@ Then add the following to `./.github/workflows/panvimdoc.yml`: pandoc: "README.md" # Input pandoc file version: "NVIM v0.8.0" # Vim version number toc: true # Table of contents - description: "" # Project Description + description: "" # Project description used in title (if empty, uses neovim version and current date) demojify: false # Strip emojis from the vimdoc dedupsubheadings: true # Add heading to subheading anchor links to ensure that subheadings are unique treesitter: true # Use treesitter for highlighting codeblocks @@ -233,7 +233,7 @@ output writer. --input-file: the input markdown file --vim-version: the version of Vim that the project is compatible with --toc: 'true' if the output should include a table of contents, 'false' otherwise - --description: a description of the project + --description: a project description used in title (if empty, uses neovim version and current date) --dedup-subheadings: 'true' if duplicate subheadings should be removed, 'false' otherwise --demojify: 'false' if emojis should not be removed, 'true' otherwise --treesitter: 'true' if the project uses Tree-sitter syntax highlighting, 'false' otherwise diff --git a/panvimdoc.sh b/panvimdoc.sh index 9a8eb62..1f994ec 100755 --- a/panvimdoc.sh +++ b/panvimdoc.sh @@ -12,7 +12,7 @@ Arguments: --input-file: the input markdown file --vim-version: the version of Vim that the project is compatible with --toc: 'true' if the output should include a table of contents, 'false' otherwise - --description: a description of the project + --description: a project description used in title (if empty, uses neovim version and current date) --dedup-subheadings: 'true' if duplicate subheadings should be removed, 'false' otherwise --demojify: 'false' if emojis should not be removed, 'true' otherwise --treesitter: 'true' if the project uses Tree-sitter syntax highlighting, 'false' otherwise