Skip to content

Commit

Permalink
chore: reduce the noise in generated doc (#29)
Browse files Browse the repository at this point in the history
* chore: reduce the noise in generated doc

* chore: add link to documentation

* chore: headless-readme

* chore: auto-generate vimdoc via panvimdoc

* fix?

* chore

* chore: auto-generate vimdoc via panvimdoc

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
novusnota and github-actions[bot] committed May 26, 2024
1 parent 50043df commit 6ac0d1a
Show file tree
Hide file tree
Showing 6 changed files with 488 additions and 35 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/panvimdoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,14 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Create a headless README
run: tail --lines=+7 README.md > doc/headless-readme.md

- name: Generate docs
uses: kdheepak/panvimdoc@main
with:
vimdoc: tact.vim
vimdoc: tact
pandoc: doc/headless-readme.md
version: "Vim 8+ and Neovim >= 0.10.0"
demojify: true
treesitter: true
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
*.tact
/doc/tags
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Note, that you can [disable highlighting of identifiers](#highlighting), if you

## Installation

### First time in Vim 8+? Read this instead
### First time in Vim 8+? Read this!

<details>
<summary><em>Click to see</em></summary>
Expand Down Expand Up @@ -88,7 +88,7 @@ vim -u NONE -c 'helptags $HOME\vimfiles\pack\tact-lang\start\tact\doc' -c q

</details>

### Vim's 8+ built-in package manager
### Built-in package manager in Vim 8+

<details>
<summary>Click to see</summary>
Expand Down Expand Up @@ -442,6 +442,7 @@ Wish you good luck and fun exploring Tact! ⚡
## Useful Tact links

- [Official Website](https://tact-lang.org/)
- [Documentation](https://docs.tact-lang.org/)
- Discussion Group in [Telegram](https://t.me/tactlang)
- [X/Twitter](https://twitter.com/tact_language)

Expand Down
Empty file removed doc/.gitkeep
Empty file.
Loading

0 comments on commit 6ac0d1a

Please sign in to comment.