https://github.com/overtrue/wisteria

Beautiful document tool for your project.
https://github.com/overtrue/wisteria

docs docs-generator laravel laravel-package markdown

Last synced: 3 months ago
JSON representation

Beautiful document tool for your project.

• Host: GitHub
• URL: https://github.com/overtrue/wisteria
• Owner: overtrue
• Archived: true
• Created: 2019-02-26T02:28:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-26T13:43:52.000Z (over 2 years ago)
• Last Synced: 2024-06-22T16:57:47.974Z (4 months ago)
• Topics: docs, docs-generator, laravel, laravel-package, markdown
• Language: Blade
• Homepage:
• Size: 4.72 MB
• Stars: 255
• Watchers: 11
• Forks: 40
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

• jimsghstars - overtrue/wisteria - Beautiful document tool for your project. (Blade)

README

        


 Beautiful document tool for your project.


[![Sponsor me](https://github.com/overtrue/overtrue/blob/master/sponsor-me-button-s.svg?raw=true)](https://github.com/sponsors/overtrue)

## Installing

```bash

$ composer require overtrue/wisteria -vvv

```

## Usage

### Installation

```bash

$ composer require overtrue/wisteria -vvv

```

Publish config and required assets:

```bash

$ php artisan wisteria:install

```

Update config file `config/wisteria.php` with right repository url of your docs, Then init the docs files:

```bash

$ php artisan wisteria:refresh

```

Done. 

## Credits

- [LaRecipe](https://github.com/saleem-hadad/larecipe) - Made by [@saleem-hadad](https://github.com/saleem-hadad)  

- [tailwindcss/tailwindcss](https://github.com/tailwindcss/tailwindcss) - A utility-first CSS framework for rapid UI development made by [@adamwathan](https://github.com/adamwathan).

- [laravel/mix](https://laravel-mix.com/)

## :heart: Sponsor me 

[![Sponsor me](https://github.com/overtrue/overtrue/blob/master/sponsor-me.svg?raw=true)](https://github.com/sponsors/overtrue)

如果你喜欢我的项目并想支持它，[点击这里 :heart:](https://github.com/sponsors/overtrue)

## Contributing

You can contribute in one of three ways:

1. File bug reports using the [issue tracker](https://github.com/overtrue/wisteria/issues).

2. Answer questions or fix bugs on the [issue tracker](https://github.com/overtrue/wisteria/issues).

3. Contribute new features or update the wiki.

_The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable._

## License

MIT