Comments (5)
This sounds interesting, we can create a few twig templates and render the available commands md files.
from drupal-console-book.
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.
@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.
from drupal-console-book.
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.
Cosidered closed since generate:doc:gitbook
command is working properly
from drupal-console-book.
Related Issues (20)
- Remove console with composer global installation
- Rename `console` to `drupal`
- [docs] Add homebrew-php as installation option HOT 2
- Note mentions -y argument, but sample code contains -n HOT 5
- [module:download] Update options
- What is DrupalStyle?
- cache:rebuild page should inform about all the available caches to rebuild HOT 1
- Files missing for Permissions & Interactive Mode links
- Content missing for Permissions & Interactive Mode files
- Russian translation to be updated HOT 5
- Rewrite the Getting the Project page to better explain the difference between the global and local installation. HOT 1
- Rewrite the What is the Drupal Console page to more fully explain he capabilities of Console. HOT 1
- Create a FAQ overview page to make it easier to reference from other pages in the docs.
- Temporarily mark site:mode command as unavailable. HOT 1
- Temporarily mark site:new command as unavailable HOT 1
- downloading the launcher doesn't work HOT 1
- Modify launcher page to better explain what launcher is and that it is not all you need. HOT 2
- module:install --composer says uninstall instead of install HOT 1
- Add descriptive text to composer install page HOT 1
- Inform about dependencies
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from drupal-console-book.