GithubHelp home page GithubHelp logo

Comments (5)

jmolivas avatar jmolivas commented on July 21, 2024

Probably won't be that complex to create a script to iterate the directories and scan md files extract h1 # to generate the links, we may need to rename files as 01_ to set the order of the links within a directory.

from drupal-console-book.

LowellMontgomery avatar LowellMontgomery commented on July 21, 2024

Right... just what I was thinking.

We could even have a standard that anything directly under the H1 could be taken as a "page synopsis" that could be used as the link title (for better UX / SEO, i.e. so people more easily find what they want).

Even cooler might be to also parse H2s and allow jumping directly to them... on pages where there is enough information that this could be useful. I'll create a new branch for the few necessary file changes. Then I'll look for an existing script or write one and share it... it might be useful for other projects, but that thought suddenly seems so true that I'm sure it must exist already, which could allow us to continue to build on "proudly found elsewhere". ;-)

from drupal-console-book.

jmolivas avatar jmolivas commented on July 21, 2024

@LowellMontgomery: I am planning to add a new command that takes advantage of PR hechoendrupal/drupal-console#868 I mentioned on the other issue #53

This command will iterate each one of the commands and generate both
Index
https://github.com/hechoendrupal/drupal-console-book/blob/master/commands/available-commands.md
And each command page
https://github.com/hechoendrupal/drupal-console-book/tree/master/commands

I can add some logic to read the repo files and generate the Summary file as well
https://github.com/hechoendrupal/drupal-console-book/blob/master/SUMMARY.md

from drupal-console-book.

jmolivas avatar jmolivas commented on July 21, 2024

Summary section related to Available Commands is now automatically generated by the new generate:doccommand.

from drupal-console-book.

jmolivas avatar jmolivas commented on July 21, 2024

@LowellMontgomery Closing this one, feel to open or create a another issue for new ideas for improvement the doc automation.

from drupal-console-book.

Related Issues (20)

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.