https://github.com/vim-jp/vimdoc-en
https://github.com/vim-jp/vimdoc-en
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vim-jp/vimdoc-en
- Owner: vim-jp
- Created: 2017-02-04T01:45:40.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T12:54:29.000Z (over 1 year ago)
- Last Synced: 2024-10-29T15:21:29.742Z (over 1 year ago)
- Language: Vim Script
- Homepage: https://vim-jp.org/vimdoc-en/
- Size: 117 MB
- Stars: 7
- Watchers: 8
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vimdoc-en
This project provides an HTML version of the Vim help pages at .
There is already another similar site: .
The main purpose of the vimdoc-en project is to provide a handy way to see both Japanese and English versions of the help pages.
The help pages are automatically updated everyday (if there are any changes).
## for Developers
First of all, to generate everything, just run `make`.
This requires Docker, so prepare it in advance.
Here's what's happening:
1. Run `make html` to generate HTML files before GitHub Pages (Jekyll) processing
1. Download vim and vim\_faq
2. Collect the necessary \*.txt files
3. Convert the \*.txt files to \*.html
2. Run `make jekyll-build-by-docker` to output all HTML files for the vimdoc-en site using GitHub Pages (Jekyll)