Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 1.88 KB

README.md

File metadata and controls

48 lines (27 loc) · 1.88 KB
Raw

vimways.org

This is the main repository for vimways.org, a project by @romainl and @robertmeta.

Vimways.org is largely inspired by 24ways.org but, instead of covering such broad subjects as web design and web development, our focus will exclusively be on delivering high quality articles about Vim and its thriving ecosystem.

Requirements

Vimways is a static website built with Hugo. Currently, we are using the extended variant of version 0.55 because it includes SASS compilation.

Local usage

Clone the project on your machine, move into it, and run the command below:

$ hugo server
  • The site should be accessible at this address: http://localhost:1313/, with LiveReload enabled.
  • Hugo should watch a number of subdirectories for changes and rebuild the site accordingly.

If you want to see draft pages and pages scheduled for future publication, use the -D and -F flags respectively:

$ hugo server -DF

Articles

The articles are in content/YYYY/: content/2018/, content/2019/, etc.

They are written in Markdown, with the addition of a front matter specific to Hugo.

Contributing

  1. Fork the original repository.
  2. Clone your fork on your machine.
  3. Move into the repo.
  4. Do $ hugo new --kind vimways 2019/title-of-your-article to bootstrap a new article under content/2019/.
  5. Push your work to your fork.
  6. Make a pull request on the original repository.

Meta pages

The About and Authors pages are in content/.

Theme

The theme is completely custom.