Skip to content

Commit

Permalink
[v3] Update Markdown files to latest spec (#111)
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 1191290 commit bab37ee
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/ABOUT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# About

Lisp Flavoured Erlang (AKA LFE) is a lisp syntax front-end to the Erlang compiler.
Code produced with it is compatible with "normal" Erlang code.
LFE is a (proper) Lisp based on the features and limitations of the Erlang VM.
Expand Down
8 changes: 5 additions & 3 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Installation

First, make sure you have Erlang installed, following the instructions on the
[Erlang][1] installation page as appropriate.
[1]: /languages/erlang

### Homebrew for Mac OS X
## Homebrew for Mac OS X

Update your Homebrew to latest:

Expand All @@ -16,7 +18,7 @@ Install LFE:
$ brew install lfe
```

### Using a docker container
## Using a docker container
If you just want to quickly take a look at LFE without polluting your
system with new packages, you can just pull a docker container with
LFE preinstalled.
Expand Down Expand Up @@ -50,7 +52,7 @@ ok
Nice! Use `(exit)` or Ctrl-C (C-c) twice to exit.
### Installing from Source
## Installing from Source
Install your system's "developer tools" or "essential build packages", `git`
and Erlang's `erl`.
Expand Down
2 changes: 2 additions & 0 deletions docs/LEARNING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Learning

Exercism provides exercises and feedback but can be difficult to jump into for
those learning LFE for the first time. These resources can help you get started:

Expand Down
2 changes: 2 additions & 0 deletions docs/RESOURCES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Resources

2 changes: 2 additions & 0 deletions docs/TESTS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Tests

For each example, the following general steps are required.

First, change directory to the exercise you want to practice, in
Expand Down
2 changes: 2 additions & 0 deletions exercises/practice/bob/.meta/description.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Description

Bob is a lackadaisical teenager. In conversation, his responses are very limited.

Bob answers 'Sure.' if you ask him a question.
Expand Down

0 comments on commit bab37ee

Please sign in to comment.