Giter Club home page Giter Club logo

ddev-readme's Introduction

tests project is maintained

What is ddev-readme?

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

It uses prettier and markdown-toc.

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 with

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

Contributed and maintained by @hanoii

ddev-readme's People

Contributors

hanoii avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.