Skip to content

Commit

Permalink
[v3] Update Markdown files to latest spec (#103)
Browse files Browse the repository at this point in the history
* [v3] Add level one headings to Markdown files.

All Markdown files should, from this point on, start with a level one heading.
See exercism/configlet#150 for the rationale behind these changes.

The full specification can be found [here](https://github.com/exercism/docs/blob/main/contributing/standards/markdown.md).

* [v3] Markdown sub-headings must be parent level incremented by one.

The full specification can be found [here](https://github.com/exercism/docs/blob/main/contributing/standards/markdown.md).
  • Loading branch information
ErikSchierboom authored May 4, 2021
1 parent 2943075 commit 87b10de
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ request.
## Writing test files
#### Generating test files
### Generating test files
Use the [generator](lib/generate.vim) to create Vader files from their canonical
test data:
Expand Down
2 changes: 2 additions & 0 deletions docs/ABOUT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# About

[Vim](http://www.vim.org) is a decades old text editor that is still wildly popular among programmers and people who like working in terminal emulators.

In Vim, keys don't always do the same things.
Expand Down
10 changes: 5 additions & 5 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Installation
# Installation

You need [Vim](http://www.vim.org) to do the exercises:

Expand All @@ -7,7 +7,7 @@ You need [Vim](http://www.vim.org) to do the exercises:
- [Windows](#windows)
- [Source](#source)

#### macOS
## macOS

The OS ships with Vim by default, but it's a hopelessly outdated version.

Expand All @@ -30,7 +30,7 @@ $ sudo port install vim +huge
If you want a GUI, have a look at [MacVim](https://macvim-dev.github.io/macvim)
instead.

#### Ubuntu / Debian
## Ubuntu / Debian

Install a full-fledged Vim with GUI support (`gvim`):

Expand All @@ -39,7 +39,7 @@ $ sudo apt-get update
$ sudo apt-get install vim-gtk
```

#### Windows
## Windows

Using [Chocolatey](https://chocolatey.org):

Expand All @@ -49,7 +49,7 @@ C:\> choco install vim

Or download and install directly from [here](http://www.vim.org/download.php#pc).

#### Source
## Source

If you want to compile the latest Vim yourself, check out the [official
repository on GitHub](https://github.com/vim/vim).
2 changes: 1 addition & 1 deletion docs/LEARNING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## LEARNING
# LEARNING

Vim comes with great documentation built in already. The interface to the
documentation is the `:help` command.
Expand Down
10 changes: 5 additions & 5 deletions docs/RESOURCES.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
## RESOURCES
# RESOURCES

#### General resources
## General resources

- [vim-galore](https://github.com/mhinz/vim-galore) is a huge guide about all
things Vim.
- [Why, oh WHY, do those #?@! nutheads use vi?](http://www.viemu.com/a-why-vi-vim.html) explains common misconceptions about vi and Vim.
- [Your problem with Vim is that you don't grok vi](http://stackoverflow.com/a/1220118) is a pure gem. Read it every once in a while.

#### Vim scripting
## Vim scripting

- [Learn Vimscript the Hard Way](http://learnvimscriptthehardway.stevelosh.com)
- [IBM DeveloperWorks: Scripting the Vim
editor](http://www.ibm.com/developerworks/views/linux/libraryview.jsp?sort_order=asc&sort_by=Title&search_by=scripting+the+vim+editor)

#### Books
## Books

There is only one good book about Vim out there: [Practical
Vim](https://pragprog.com/book/dnvim2/practical-vim-second-edition).

#### Screencasts
## Screencasts

- [vimcasts.org](http://vimcasts.org/episodes/archive)
- [wincent on YouTube](https://www.youtube.com/channel/UCXPHFM88IlFn68OmLwtPmZA)
6 changes: 3 additions & 3 deletions docs/TESTS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## SETUP
# SETUP

This track uses two tools to run the test suite and ensure best practices:

1. [vader.vim](https://github.com/junegunn/vader.vim)
2. [vint](https://github.com/Kuniwak/vint)

#### Running tests
## Running tests

1. Install [vader.vim](https://github.com/junegunn/vader.vim/#installation).
1. Open your solution:
Expand Down Expand Up @@ -55,7 +55,7 @@ autocmd BufRead *.{vader,vim}
Afterwards open any `.vim` or `.vader` file from an exercise directory and run
the `:Test` command.

#### Linting Vim files
## Linting Vim files

1. Install [vint](https://github.com/Kuniwak/vint#quick-start).
1. Recursively lint all Vim files:
Expand Down

0 comments on commit 87b10de

Please sign in to comment.