Skip to content

vim-jp/vimconf.org

Repository files navigation

vimconf

Getting involved

Join vim-jp slack instead, or contact us.

(We stopped using Gitter. )

How to serve in your machine

Pre requirements

  • Docker
  • (OPTION) Python 3: to preview with local HTTP server

Build

The following command will build your site in the _site/ directory:

$ ./_scripts/docker_jekyll jekyll build

You can also specify options such as incremental options.

$ ./_scripts/docker_jekyll jekyll build -I

Serve

You can run jekyll serve with the following command.

$ ./_scripts/docker_jekyll_serve

It uses port 4000 to serve the contents. Open http://127.0.0.1:4000 with your browser.

This command accepts options as you know. To use watch and incremental builds:

$ ./_scripts/docker_jekyll_serve -wI

Auto-regeneration may not work on some Windows versions. In that case, it might be easier to serve it in Python and generate it manually in the "Build" step.

If you just want to serve without watching or building, you may do as follows.

$ ./_scripts/docker_jekyll_serve --skip-initial-build --no-watch

Serve with Python

You can run Python local HTTP server with the following command.

$ ./_scripts/python_http_server

It uses ports 8000 to serve the contents. Open http://127.0.0.1:8000 with your browser.