Skip to content

Commit 87b10de

Browse files
[v3] Update Markdown files to latest spec (exercism#103)
* [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).
1 parent 2943075 commit 87b10de

File tree

6 files changed

+17
-15
lines changed

6 files changed

+17
-15
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ request.
3333
3434
## Writing test files
3535
36-
#### Generating test files
36+
### Generating test files
3737
3838
Use the [generator](lib/generate.vim) to create Vader files from their canonical
3939
test data:

docs/ABOUT.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# About
2+
13
[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.
24

35
In Vim, keys don't always do the same things.

docs/INSTALLATION.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Installation
1+
# Installation
22

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

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

10-
#### macOS
10+
## macOS
1111

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

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

33-
#### Ubuntu / Debian
33+
## Ubuntu / Debian
3434

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

@@ -39,7 +39,7 @@ $ sudo apt-get update
3939
$ sudo apt-get install vim-gtk
4040
```
4141

42-
#### Windows
42+
## Windows
4343

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

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

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

52-
#### Source
52+
## Source
5353

5454
If you want to compile the latest Vim yourself, check out the [official
5555
repository on GitHub](https://github.com/vim/vim).

docs/LEARNING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## LEARNING
1+
# LEARNING
22

33
Vim comes with great documentation built in already. The interface to the
44
documentation is the `:help` command.

docs/RESOURCES.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
## RESOURCES
1+
# RESOURCES
22

3-
#### General resources
3+
## General resources
44

55
- [vim-galore](https://github.com/mhinz/vim-galore) is a huge guide about all
66
things Vim.
77
- [Why, oh WHY, do those #?@! nutheads use vi?](http://www.viemu.com/a-why-vi-vim.html) explains common misconceptions about vi and Vim.
88
- [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.
99

10-
#### Vim scripting
10+
## Vim scripting
1111

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

16-
#### Books
16+
## Books
1717

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

21-
#### Screencasts
21+
## Screencasts
2222

2323
- [vimcasts.org](http://vimcasts.org/episodes/archive)
2424
- [wincent on YouTube](https://www.youtube.com/channel/UCXPHFM88IlFn68OmLwtPmZA)

docs/TESTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
## SETUP
1+
# SETUP
22

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

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

8-
#### Running tests
8+
## Running tests
99

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

58-
#### Linting Vim files
58+
## Linting Vim files
5959

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

0 commit comments

Comments
 (0)