Skip to content

Commit

Permalink
docs: add toc to all md files
Browse files Browse the repository at this point in the history
  • Loading branch information
jmattaa committed Nov 24, 2024
1 parent c5df184 commit 20a58e5
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 10 deletions.
10 changes: 10 additions & 0 deletions CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@

</div>

# Table of contents
1. [Creating Your Own Configuration File](#creating-your-own-configuration-file)
2. [Writing Your Own Configuration](#writing-your-own-configuration)
1. [Constants](#constants)
1. [`L_colors`](#`l_colors`)
2. [Functions](#functions)
1. [`L_compare_entries()`](#`l_compare_entries()`)
2. [`L_long_format()`](#`l_long_format()`)
3. [Using Defaults](#using-defaults)

Laser is highly customizable through Lua scripts. The default configuration
file is located at `/usr/local/share/lsr/lsr.lua`. This file is loaded by the
program and sets the default behavior for laser. You can modify this file or
Expand Down
26 changes: 16 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,22 @@ See the [Table of Contents](#table-of-contents) for different ways to help and
details about how this project handles them. Please make sure to read the
relevant section before making your contribution.

## Table of Contents

- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Your First Code Contribution](#your-first-code-contribution)
- [Improving The Documentation](#improving-the-documentation)
- [Styleguides](#styleguides)
- [Commit Messages](#commit-messages)
## Table of contents
1. [I Have a Question](#i-have-a-question)
2. [I Want To Contribute](#i-want-to-contribute)
1. [Reporting Bugs](#reporting-bugs)
1. [Before Submitting a Bug Report](#before-submitting-a-bug-report)
2. [Suggesting Enhancements](#suggesting-enhancements)
1. [Before Submitting an
Enhancement](#before-submitting-an-enhancement)
2. [How Do I Submit a Good Enhancement
Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion?)
3. [Your First Code Contribution](#your-first-code-contribution)
1. [Development Environment Setup](#development-environment-setup)
2. [Code formatting](#code-formatting)
4. [Improving The Documentation](#improving-the-documentation)
3. [Styleguides](#styleguides)
1. [Commit Messages](#commit-messages)

## I Have a Question

Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@

</div>

## Table of contents
1. [Installation](#installation)
1. [From Homebrew](#from-homebrew)
2. [Building from source](#building-from-source)
2. [Usage](#usage)
1. [Configure](#configure)
2. [Command-line options](#command-line-options)
1. [Contributing](#contributing)
2. [Authors](#authors)

**lsr** basically `ls` but with colorization and sorting for better readability.
It offers filtering options, making it easy to
locate specific files and folders (with grep you'll find exactly what you need)
Expand Down

0 comments on commit 20a58e5

Please sign in to comment.