-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0e79d58
commit 83d040f
Showing
4 changed files
with
60 additions
and
70 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,62 @@ | ||
<div align="center"> | ||
<p> | ||
<img src="https://github.com/minicli/application/raw/main/art/minicli.png" alt="Minicli" width="150"/> | ||
<h1>Minicli Application Template</h1> | ||
</p> | ||
</div> | ||
<hr> | ||
# Autodocs Demo | ||
|
||
This repository is an application template for building command-line applications in PHP with [Minicli](https://github.com/minicli/minicli). | ||
This repository contains a demo application implementing [Autodocs](https://github.com/erikaheidi/autodocs). To run this demo, you'll need PHP >= 8.2 and Composer. | ||
|
||
Please check [the official documentation](https://docs.minicli.dev) for more information on how to use this application template. | ||
## Running the Demo | ||
Start by cloning this repository: | ||
|
||
```shell | ||
git clone https://github.com/erikaheidi/autodocs-demo.git | ||
``` | ||
|
||
Then, install dependencies with Composer: | ||
|
||
```shell | ||
cd autodocs-demo | ||
composer install | ||
``` | ||
You may want to update the file `storage/cache/profile.json` with your own data: | ||
|
||
```json | ||
{ | ||
"user": "Erika Heidi", | ||
"bio": "Software and Documentation Engineer", | ||
"projects": { | ||
"minicli/minicli": { | ||
"description": "CLI framework for PHP", | ||
"link": "https://docs.minicli.dev" | ||
}, | ||
"erikaheidi/autodocs": { | ||
"description": "Tiny framework for automating documentation", | ||
"link": "https://github.com/erikaheidi/autodocs/wiki" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
Then, run: | ||
|
||
```shell | ||
./autodocs build | ||
``` | ||
|
||
You'll get output similar to this: | ||
|
||
```shell | ||
Starting Build... | ||
|
||
Build finished. Output saved to /home/erika/Projects/autodocs-demo/config/../storage/content | ||
``` | ||
|
||
Check your `storage/content` folder, and you should find a `README.md` file there with your rendered content: | ||
|
||
```markdown | ||
## Erika Heidi | ||
|
||
Software and Documentation Engineer | ||
|
||
## My PHP Projects | ||
|
||
- [minicli/minicli](https://docs.minicli.dev): CLI framework for PHP | ||
- [erikaheidi/autodocs](https://github.com/erikaheidi/autodocs/wiki): Tiny framework for automating documentation | ||
``` |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.