Coder Social home page Coder Social logo

Comments (5)

jmolivas avatar jmolivas commented on June 12, 2024

This sounds interesting, we can create a few twig templates and render the available commands md files.

from drupal-console-book.

LowellMontgomery avatar LowellMontgomery commented on June 12, 2024

Right... I was thinking about it during the initial copy/paste/format repetition: "surely we can automate this" ;-)

Maybe the documentation and project could be in one repository for this to be most ideally implemented? Command/API documentation could be re-generated (perhaps even automagically) whenever the commands are updated or new ones added. I'm not yet the Git geek some are, so I'm not sure how to implement it, but then the command documentation could be in both repositories (the "book" and the actual Console), included in one from the other. Having the most critical "API docs" in the same repository as the Console could also just be handy for users.

from drupal-console-book.

jmolivas avatar jmolivas commented on June 12, 2024

@LowellMontgomery I just send a PR hechoendrupal/drupal-console#868, on the DrupalConsole repository.

This PR provides a new --generate-doc option to automate documentation generation.

--generate-doc

from drupal-console-book.

jmolivas avatar jmolivas commented on June 12, 2024

I sent another PR hechoendrupal/drupal-console#877 this one includes the generate:doc command, this command iterate each DrupalConsole core command and generates the proper Markdown files.

You must run the generate:doc command within a Drupal 8 installation.

$ console.dev generate:doc --path=/path/to/your/repo/drupal-console-book/

from drupal-console-book.

jmolivas avatar jmolivas commented on June 12, 2024

Cosidered closed since generate:doc:gitbook command is working properly

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.