Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo in CONTRIBUTING.md #641

Merged
merged 1 commit into from
Jun 27, 2024
Merged

Typo in CONTRIBUTING.md #641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ make test PLENARY=/path/to/your/plenary

## Building the Vim documentation

The Vim documentation lives at `docs/obsidian.txt`, which is automatically generated from the README using [panvimdoc](https://github.com/kdheepak/panvimdoc). **So please only commit documentation changes to the README, not `docs/obsidian.txt`.**
The Vim documentation lives at `doc/obsidian.txt`, which is automatically generated from the README using [panvimdoc](https://github.com/kdheepak/panvimdoc). **So please only commit documentation changes to the README, not `doc/obsidian.txt`.**

However you can test how changes to the README will affect the Vim doc by running panvimdoc locally.
To do this you'll need install `pandoc` (e.g. `brew install pandoc` on Mac) and clone [panvimdoc](https://github.com/kdheepak/panvimdoc). Then from the panvimdoc repo root, run:
Expand Down