GithubHelp home page GithubHelp logo

timfoote / auto-generate-summary Goto Github PK

View Code? Open in Web Editor NEW

This project forked from segfaultsourcery/auto-generate-summary

0.0 0.0 0.0 8 KB

mdBook - feature request: automatically generate SUMMARY.md from the list of src/*.md files #1016

Rust 100.00%

auto-generate-summary's Introduction

NOT PRODUCTION CODE

This code is crappy, it's just a quick hack to see if I got the idea. Let's discuss and see if I'm on the right track :)

If you give it a run, it should produce md compatible output from the example folder. Toy around with it and see if it does what you expect.

Also, keep in mind that the landing.md files are needed, because I need to link to something, but I can't know what's right. If a landing.md doesn't exist, a title will be guessed.


Currently, the example folder results in this:

# SUMMARY

- [Chapter 1 title parsed from markdown file](./chapter_1/landing.md)
    - [Section 1.1 title](./chapter_1/section_1_1.md)
    - [Section 1.2 title](./chapter_1/section_1_2.md)
    - [Section 1.3 title](./chapter_1/section_1_3.md)
- [Chapter 2 title](./chapter_2/landing.md)
    - [Section 2.1 title](./chapter_2/section_2_1.md)

auto-generate-summary's People

Contributors

segfaultsourcery 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.