https://github.com/dillingham/notable
https://github.com/dillingham/notable
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/dillingham/notable
- Owner: dillingham
- Created: 2020-09-07T16:57:46.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T03:10:03.000Z (over 3 years ago)
- Last Synced: 2025-03-31T11:11:12.296Z (over 1 year ago)
- Language: PHP
- Size: 70.3 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Notable
A simple documentation package for Laravel.
```
php artisan notable:install
```
- adds a `docs` folder in your project's root for markdown
- adds a `docs` folder in resources/views for the page layout
- adds the following route to the top of routes/web.php
```
Route::markdown('docs', base_path('docs'));
```
1st parameter is the endpoint to make the root
2nd parameter is a path to a markdown folder
A file with the following path in a project:
```
docs/getting-started/installation.md
```
will appear like this in the browser
```
docs/getting-started/installation
```
Note: `docs` in the url is from Route definition
It isn't the folder's name. It can be changed.
### TODO:
- [ ] Cache html rendered markdown.. if modified time > last cache, render
- [ ] Add folder and file number ordering 1-getting-started -> 1-installation
- [ ] Add route helpers for settings (see below)
- [ ] Add "On this page" section links
- [ ] Add repository config for "edit page"
```php
Route::markdown()
->directory(base_path('docs'))
->prefix('documentation')
->view('docs.show')
->sections(config('docs.sections'))
```