-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
generate:module creates skeletal mkdocs content
Just generates mkdocs.yml and docs/index.md with a couple of Template builders in the main InitCommand for now. Alternatively, could create a Docs builder and/or command. Fixes #161
- Loading branch information
Showing
3 changed files
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# <?php echo $fullName; ?> | ||
|
||
## Overview | ||
|
||
FIXME | ||
|
||
### Features | ||
|
||
* FIXME | ||
|
||
## Requirements | ||
|
||
* CiviCRM x.y or higher | ||
|
||
## Known Issues | ||
|
||
* None yet! | ||
|
||
## Future plans |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Use mkdocs to generate a manual for this extension. For more information about | ||
# mkdocs, see https://docs.civicrm.org/dev/en/latest/documentation/#mkdocs | ||
site_name: <?php echo "$fullName\n"; ?> | ||
repo_url: https://lab.civicrm.org/extensions/FIXME | ||
site_description: 'A guide for the <?php echo "$fullName\n"; ?> extension.' | ||
site_author: FIXME | ||
theme: | ||
name: material | ||
|
||
nav: | ||
- Home: index.md | ||
|
||
markdown_extensions: | ||
- attr_list | ||
- admonition | ||
- def_list | ||
- pymdownx.highlight | ||
guess_lang: false | ||
- toc: | ||
permalink: true | ||
- pymdownx.superfences | ||
- pymdownx.inlinehilite | ||
- pymdownx.tilde | ||
- pymdownx.betterem | ||
- pymdownx.mark | ||
|
||
plugins: | ||
- search: | ||
lang: en |