File tree Expand file tree Collapse file tree 1 file changed +26
-0
lines changed Expand file tree Collapse file tree 1 file changed +26
-0
lines changed Original file line number Diff line number Diff line change @@ -231,6 +231,32 @@ For an example of how this is used, see one of the following workflows:
231231_Feel free to submit a PR to add your documentation as an example here._
232232
233233
234+ USING IT MANUALLY ~
235+
236+ The `./entrypoint.sh ` script runs `pandoc` along with all the filters and
237+ custom output writer.
238+
239+ >bash
240+ $ ./entrypoint.sh
241+ Usage: ./entrypoint.sh --project-name PROJECT_NAME --input-file INPUT_FILE --vim-version VIM_VERSION --toc TOC --description DESCRIPTION --dedup-subheadings DEDUP_SUBHEADINGS --treesitter TREESITTER
242+
243+ Arguments:
244+ --project-name: the name of the project
245+ --input-file: the input markdown file
246+ --vim-version: the version of Vim that the project is compatible with
247+ --toc: 'true' if the output should include a table of contents, 'false' otherwise
248+ --description: a description of the project
249+ --dedup-subheadings: 'true' if duplicate subheadings should be removed, 'false' otherwise
250+ --demojify: 'false' if emojis should not be removed, 'true' otherwise
251+ --treesitter: 'true' if the project uses Tree-sitter syntax highlighting, 'false' otherwise
252+ --ignore-rawblocks: 'true' if the project should ignore HTML raw blocks, 'false' otherwise
253+ --shift-heading-level-by: 0 if you don't want to shift heading levels , n otherwise
254+ --increment-heading-level-by: 0 if don't want to increment the starting heading number, n otherwise
255+ <
256+
257+ You will need `pandoc v3.0.0` or greater for this script to work.
258+
259+
234260==============================================================================
2352618. References *panvimdoc-references*
236262
You can’t perform that action at this time.
0 commit comments