Skip to content

Commit

Permalink
feat(docs): Add orgmode docs
Browse files Browse the repository at this point in the history
feat(docs): Add orgmode docs
  • Loading branch information
kristijanhusak committed Jan 19, 2025
1 parent 3ba6db7 commit 133a928
Show file tree
Hide file tree
Showing 15 changed files with 4,144 additions and 326 deletions.
38 changes: 20 additions & 18 deletions .github/workflows/docgen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- master
- feat/docs

jobs:
docgen:
Expand All @@ -12,11 +13,10 @@ jobs:
- uses: actions/checkout@v4
with:
token: ${{ secrets.GH_TOKEN }}
- uses: actions/setup-go@v5
- name: Install pandoc
uses: pandoc/actions/setup@v1
with:
go-version: '^1.17.1'
- name: Install md2vim
run: go install git.foosoft.net/alex/md2vim@latest
version: 3.5
- name: Install Neovim
uses: rhysd/action-setup-vim@v1
id: neovim
Expand All @@ -30,17 +30,19 @@ jobs:
- name: Generate api docs
run: make api_docs
- name: Generate vim docs
run: make docs
- name: Commit changes
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
COMMIT_MSG: |
[docgen] Update docs
run: |
rm lemmy-help
git config user.name github-actions
git config user.email github-actions@github.com
git add doc/orgmode.txt
git add doc/orgmode_api.txt
# Only commit and push if we have changes
git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push)
run: make vim_docs
- name: Print vim docs
run: cat doc/orgmode.txt
# - name: Commit changes
# env:
# GH_TOKEN: ${{ secrets.GH_TOKEN }}
# COMMIT_MSG: |
# [docgen] Update docs
# run: |
# rm lemmy-help
# git config user.name github-actions
# git config user.email github-actions@github.com
# git add doc/orgmode.txt
# git add doc/orgmode_api.txt
# # Only commit and push if we have changes
# git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push)
52 changes: 0 additions & 52 deletions CONTRIBUTING.md

This file was deleted.

1 change: 1 addition & 0 deletions CONTRIBUTING.org
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Check [[file:./docs/contributing.org][contributing]] for more information
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ clean:
nvim --headless --clean -n -c "lua vim.fn.delete('./tests/.deps', 'rf')" +q
test:
nvim --headless --clean -u tests/test.lua "$(FILE)"
docs:
md2vim -desc "*orgmode* *orgmode.nvim*\n* NOTE: This file is autogenerated from DOCS.md file" DOCS.md doc/orgmode.txt
vim_docs:
./scripts/build_docs.sh
api_docs:
nvim --headless --clean -u ./scripts/gendoc.lua
setup_dev:
Expand Down
Loading

0 comments on commit 133a928

Please sign in to comment.