https://github.com/vim-advent-calendar/vimways.org

vimways.org
https://github.com/vim-advent-calendar/vimways.org

vim

Last synced: 1 day ago
JSON representation

vimways.org

• Host: GitHub
• URL: https://github.com/vim-advent-calendar/vimways.org
• Owner: vim-advent-calendar
• License: mit
• Created: 2018-08-26T09:04:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-15T07:10:34.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T05:13:11.222Z (3 months ago)
• Topics: vim
• Language: SCSS
• Size: 80.3 MB
• Stars: 218
• Watchers: 35
• Forks: 29
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vimways.org

This is the main repository for [vimways.org](https://vimways.org), a project by [@romainl](https://github.com/romainl) and [@robertmeta](https://github.com/robertmeta).

[Vimways.org](https://vimways.org) is largely inspired by [24ways.org](https://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](https://www.vim.org/) and its thriving ecosystem.

## Requirements

Vimways is a static website built with [Hugo](https://gohugo.io). Currently, we are using the *extended* variant of [**version 0.55**](https://github.com/gohugoio/hugo/releases/tag/v0.55.6) 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/](http://localhost:1313), with [LiveReload](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=fr) 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.

[//]: # ( Vim: set spell spelllang=en: )