https://github.com/hanoii/ddev-readme

An opinionated README formatter
https://github.com/hanoii/ddev-readme

ddev-get

Last synced: 9 days ago
JSON representation

An opinionated README formatter

• Host: GitHub
• URL: https://github.com/hanoii/ddev-readme
• Owner: hanoii
• License: apache-2.0
• Created: 2024-03-08T15:28:20.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-08-21T15:18:19.000Z (3 months ago)
• Last Synced: 2024-10-19T08:17:15.666Z (about 1 month ago)
• Topics: ddev-get
• Language: Shell
• Homepage:
• Size: 106 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![tests](https://github.com/hanoii/ddev-readme/actions/workflows/tests.yml/badge.svg)](https://github.com/hanoii/ddev-readme/actions/workflows/tests.yml)

![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)

- [What is ddev-readme?](#what-is-ddev-readme)

- [TOC](#toc)

- [Install the dev version](#install-the-dev-version)

## What is ddev-readme?

This is an opinionated approach to keeping README.md a bit standarized

formatter.

It uses [prettier](https://prettier.io/) and

[markdown-toc](https://www.npmjs.com/package/markdown-toc?activeTab=readme).

Once installed and `ddev restart`, it will start up a process watching for

changes on your README.md. If you wish to disable this you can edit and remove

`#ddev-generated` from `config.readme.yaml` or add

`DDEV_README_WATCH_DISABLED=true` as en environment variable to your project.

## TOC

For you toc generation to work automatically, you have to add the following

somewhere on your README.md:

**<!-- toc -->**

**<!-- tocstop -->**

## Install the dev version

You can always install the latest code:

For DDEV v1.23.5 or above run

```sh

ddev add-on get https://github.com/hanoii/ddev-readme/tarball/main

```

For earlier versions of DDEV run

```sh

ddev get https://github.com/hanoii/ddev-readme/tarball/main

```

**Contributed and maintained by [@hanoii](https://github.com/hanoii)**