0

toc-me: a GitHub app that updates a table of content for markdown files by @paholleran #GitHub #Markdown

A GitHub App built with Probot that runs markdown-toc

Markdown is “yet another markup language” you need to learn to document things, especially on GitHub. But how do you automate things like generating a table of contents?

Philip Holleran (Twitter @paholleran) has you covered. toc-me is a GitHub App built with Probot that runs markdown-toc.

Teams often use GitHub to manage documentation. As that documentation grows navigation can become a challenge, leading to the addition of a table of contents (ToC). As the documentation is modified team members must take care to ensure the ToC links are properly nested and formatted, which can create a barrier to contribution.

This app examines each push operation for markdown files formatted to use markdown-toc. When such files are found, toc-me regenerates a new ToC for the file and inserts it in the configured location.

Check out this GitHub repo for more.

 


Stop breadboarding and soldering – start making immediately! Adafruit’s Circuit Playground is jam-packed with LEDs, sensors, buttons, alligator clip pads and more. Build projects with Circuit Playground in a few minutes with the drag-and-drop MakeCode programming site, learn computer science using the CS Discoveries class on code.org, jump into CircuitPython to learn Python and hardware together, or even use Arduino IDE. Circuit Playground Express is the newest and best Circuit Playground board, with support for MakeCode, CircuitPython, and Arduino. It has a powerful processor, 10 NeoPixels, mini speaker, InfraRed receive and transmit, two buttons, a switch, 14 alligator clip pads, and lots of sensors: capacitive touch, IR proximity, temperature, light, motion and sound. A whole wide world of electronics and coding is waiting for you, and it fits in the palm of your hand.

Join 10,000+ makers on Adafruit’s Discord channels and be part of the community! http://adafru.it/discord

CircuitPython 2019!

Have an amazing project to share? Join the SHOW-AND-TELL every Wednesday night at 7:30pm ET on Google+ Hangouts.

Join us every Wednesday night at 8pm ET for Ask an Engineer!

Follow Adafruit on Instagram for top secret new products, behinds the scenes and more https://www.instagram.com/adafruit/


Maker Business — The sustainability of open source software

Wearables — The final environment

Electronics — Voltage drop from cables

Biohacking — Three DIY Photobioreactor Designs for Algae Growing

Python for Microcontrollers — Python snakes its way to Codecademy, beta 7, games, calculators, turning 6 and more! #Python #Adafruit #CircuitPython @circuitpython @micropython @ThePSF @Adafruit

Get the only spam-free daily newsletter about wearables, running a "maker business", electronic tips and more! Subscribe at AdafruitDaily.com !



No Comments

No comments yet.

Sorry, the comment form is closed at this time.